From a32e74b43651e8b3de49476c99fa5c3f441f7890 Mon Sep 17 00:00:00 2001 From: Daniele Sluijters Date: Sun, 5 Jun 2016 15:44:00 +0200 Subject: [PATCH] Add .github/ with PR and issue templates Closes #121 --- moduleroot/.github/ISSUE_TEMPLATE.md | 25 ++++++++++++++++++++ moduleroot/.github/PULL_REQUEST_TEMPLATE.md | 26 +++++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 100644 moduleroot/.github/ISSUE_TEMPLATE.md create mode 100644 moduleroot/.github/PULL_REQUEST_TEMPLATE.md diff --git a/moduleroot/.github/ISSUE_TEMPLATE.md b/moduleroot/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..79251b63 --- /dev/null +++ b/moduleroot/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,25 @@ +Please check the following items before submitting an issue -- thank you! + +- [ ] There is no existing issue or PR that addresses this problem + +Optional but makes our lives much easier: + +- [ ] The issue affects the latest release of this module + +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/). + +- - - + +Please erase this part and provide a complete description of your issue. It +should roughly contain the following information: + +* Affected module version, i.e: 5.0.1 +* Affected OS distribution and version, i.e: Ubuntu 14.04 +* Puppet version, i.e: Puppet 4.5.1 +* How you installed Puppet, i.e: from gem, distribution packages, + Puppetlabs AIO +* How the bug got triggered, i.e: I included the class and set parameter `x` + to `y`, or I added `a::resource { 'thing': x => 'y'}` to my manifests +* What output you got, the complete error message and anything else +* What behaviour you expected instead, i.e: I wanted to create an apt + source entry pointing containing diff --git a/moduleroot/.github/PULL_REQUEST_TEMPLATE.md b/moduleroot/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..3e20ad2c --- /dev/null +++ b/moduleroot/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,26 @@ +Please check the following items before submitting a PR -- thank you! + +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/). + +- [ ] There is no existing PR that addresses this problem +- [ ] Mentioned any existing issues in your commit so they get linked and + closed once this PR gets merged, i.e: `Closes #1554` in the body of a commit +- [ ] Followed the instructions in the [Contributing](CONTRIBUTING.md) document +- [ ] Ran the unit/spec tests and ensured they still pass +- [ ] Added tests to cover the new behaviour +- [ ] Updated the documentation to match the changes +- [ ] Squashed your PR down to a single commit. You may forego this if the PR + tries to address multiple issues. Though we prefer one PR per feature/fix, + sometimes that's not feasible. In that case ensure that every feature/fix + and associated tests and documentation make up one commit + +Optional but extra points: + +- [ ] Added tests to ensure the old behaviour cannot accidentally be + reintroduced + +- - - + +Please erase this and provide further information about your PR. +It should contain all the necessary information for the maintainers to be +able to understand the issue at hand and the code behind fixing it.