add DCO (first draft)

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+### Short description
+<!-- Write a small description of what this Pull Request fixes or provides, including the issue #s -->
+<!-- For example, `Fixes #12345` -->
+
+### Checklist
+<!-- please indicate if any of these things are done/included with this Pull Request. Not all boxes need to be checked for the Pull Request to be accepted -->
+I have:
+- [ ] read the [CONTRIBUTING.md](https://github.com/OpenVoxProject/.github/blob/main/CONTRIBUTING.md) document
+- [ ] read and accepted the [Developer Certificate of Origin](https://github.com/OpenVoxProject/.github/blob/main/DCO.md) document and added a [`Signed-off-by`](https://github.com/OpenVoxProject/.github/blob/main/CONTRIBUTING.md#developer-certificate-of-origin) annotation to each of my commits
+- [ ] tested this code
+- [ ] included documentation (including possible behaviour changes)
+- [ ] documented the code
+- [ ] added or modified regression test(s)
+- [ ] added or modified unit test(s)

CONTRIBUTING.md

@@ -0,0 +1,128 @@
+# Contribution guidelines
+
+## Table of contents
+
+* [Contributing](#contributing)
+* [Writing proper commits - short version](#writing-proper-commits-short-version)
+* [Writing proper commits - long version](#writing-proper-commits-long-version)
+  * [Make separate commits for logically separate changes](#make-separate-commits-for-logically-separate-changes)
+  * [Developer Certificate of Origin](#developer-certificate-of-origin)
+  * [Sending your patches](#sending-your-patches)
+  * [Update the related GitHub issue](#update-the-related-gitHub-issue)
+* [Puppet development and testing](#puppet-development-and-testing)
+  * [The test matrix](#the-test-matrix)
+  * [Syntax and style](#syntax-and-style)
+  * [Running the unit tests](#running-the-unit-tests)
+  * [Integration tests](#integration-tests)
+* [Gem development and testing](#gem-development-and-testing)
+
+This project has grown over time based on a range of contributions from people using it.
+If you follow these contributing guidelines your patch will likely make it into a release a little more quickly.
+
+## Contributing
+
+Please note that this project is released with a Contributor Code of Conduct.
+By participating in this project you agree to abide by its terms [Contributor Code of Conduct](https://voxpupuli.org/coc/).
+
+* Fork the repo.
+* Create a separate branch for your change.
+* We only take pull requests with passing tests, and documentation. [GitHub Actions](https://docs.github.com/en/actions) run the tests for us. You can also execute them locally. This is explained [in a later section](#the-test-matrix).
+* For Puppet Code: Checkout [our docs](https://voxpupuli.org/docs/reviewing_pr/) we use to review a module and the [official styleguide](https://puppet.com/docs/puppet/latest/style_guide.html). They provide some guidance for new code that might help you before you submit a pull request.
+* Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, please add a test.
+* Squash your commits down into logical components. Make sure to rebase against our current HEAD branch. You don't have to squash everything into a single commit.
+* Push the branch to your fork and submit a pull request.
+
+Please be prepared to repeat some of these steps as our contributors review your code.
+
+If this is a Puppet Module: Also consider sending in your profile code that calls this component module as an acceptance test or provide it via an issue. This helps reviewers a lot to test your use case and prevents future regressions!
+
+## Writing proper commits - short version
+
+* Make commits of logical units.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Commit using Unix line endings (check the settings around "crlf" in git-config(1)).
+* Do not check in commented out code or unneeded files.
+* The first line of the commit message should be a short description (50 characters is the soft limit, excluding ticket number(s)), and should skip the full stop.
+* The body should provide a meaningful commit message, which:
+  * uses the imperative, present tense: `change`, not `changed` or `changes`.
+  * includes motivation for the change, and contrasts its implementation with the previous behavior.
+  * Make sure that you have tests for the bug you are fixing, or feature you are adding.
+  * Make sure the test suites passes after your commit:
+  * When introducing a new feature, make sure it is properly documented in the README.md
+  * A detailed explanation is also available at [cbea.ms/git-commit](https://cbea.ms/git-commit/)
+* Include a valid `Signed-off-by` annotation as a [Developer Certificate of Origin](https://en.wikipedia.org/wiki/Developer_Certificate_of_Origin). See the [OpenVox Project DCO](https://github.com/OpenVoxProject/.github/blob/main/DCO.md)
+
+## Writing proper commits - long version
+
+### Make separate commits for logically separate changes
+
+Please break your commits down into logically consistent units which include new or changed tests relevant to the rest of the change.
+The goal of doing this is to make the diff easier to read for whoever is reviewing your code.
+In general, the easier your diff is to read, the more likely someone will be happy to review it and get it into the code base.
+
+If you are going to refactor a piece of code, please do so as a separate commit from your feature or bug fix changes.
+
+We also really appreciate changes that include tests to make sure the bug is not re-introduced, and that the feature is not accidentally broken.
+
+Describe the technical detail of the change(s). If your description starts to get too long, that is a good sign that you probably need to split up your commit into more finely grained pieces.
+
+Commits which plainly describe the things which help reviewers check the patch and future developers understand the code are much more likely to be merged in with a minimum of bike-shedding or requested changes.
+Ideally, the commit message would include information, and be in a form suitable for inclusion in the release notes for the version of Puppet that includes them.
+
+Please also check that you are not introducing any trailing whitespace or other "whitespace errors".
+You can do this by running `git diff --check` on your changes before you commit.
+
+### Developer Certificate of Origin
+
+We require a `Signed-off-by` annotation on all commits contributed to the OpenVoxProject codebase, as a [Developer Certificate of Origin](https://en.wikipedia.org/wiki/Developer_Certificate_of_Origin). See the [OpenVox Project DCO](https://github.com/OpenVoxProject/.github/blob/main/DCO.md).
+
+If you have properly configured `user.name` and `user.email` in your `Git` configuration, `Git` includes a `-s` or `--signoff` command line option to append this line automatically to your commit message:
+
+```sh
+git commit --signoff -m 'Commit message'
+```
+
+If you already committed your changes, and you have only one commit on your branch, you can use `git commit --amend --signoff` to add a sign-off to the latest commit.
+If you have more than one commit on your branch, you can instead use `git rebase` to add a sign-off to existing commits. For example, if your branch is based on the `master` one:
+
+```sh
+git rebase --signoff master
+```
+
+If you've already pushed commits without the proper signoff to a branch and are attempting to remediate this, then just force-push them after adding the proper annotations.
+
+```sh
+git push --force-with-lease origin <branchname>
+```
+
+### Sending your patches
+
+To submit your changes via a GitHub pull request, we _highly_ recommend that you have them on a topic branch, instead of directly on your default HEAD branch (usually `main` or `master`).
+It makes things much easier to keep track of, especially if you decide to work on another thing before your first change is merged in.
+Vox Pupuli Maintainers have the option to rebase the source branch of a pull request, and you don't want that to happen in your HEAD branch.
+
+GitHub has some pretty good [general documentation](http://support.github.com/) on using their site.
+They also have documentation on [creating pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
+
+In general, after pushing your topic branch up to your repository on GitHub, you can switch to the branch in the GitHub UI and click "Pull Request" towards the top of the page in order to open a pull request.
+
+### Update the related GitHub issue
+
+If there is a GitHub issue associated with the change you submitted, then you should update the ticket to include the location of your branch, along with any other commentary you may wish to make.
+
+## Puppet testing
+
+[How to run the test suite](https://voxpupuli.org/docs/how_to_run_tests/)
+
+## Gem development and testing
+
+At the moment Vox Pupuli does not have a unified test setup for gems.
+The majority of them use [rspec](https://rspec.info/) tests.
+Some also [cucumber](https://cucumber.io/).
+
+Our goal is that running `bundle exec rake` always executes the whole test matrix.
+If this isn't yet the case for a project you're working on, please [let us know](https://voxpupuli.org/contributing/).
+Usually there's also a rake task named `test` or `spec`.
+You can list all available rake tasks with `bundle exec rake --tasks`.
+All our gems run tests in GitHub Actions.
+You can always check `.github/workflows/` and check what the CI does.

DCO.md

@@ -0,0 +1,25 @@
+Developer Certificate of Origin
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the LICENSE file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the LICENSE file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.