Skip to content

Commit

Permalink
Add .github/ with PR and issue templates
Browse files Browse the repository at this point in the history
Closes #121
  • Loading branch information
daenney committed Jun 5, 2016
1 parent 3afaebf commit 5cb4cd6
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
23 changes: 23 additions & 0 deletions moduleroot/.github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
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 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
26 changes: 26 additions & 0 deletions moduleroot/.github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Please check the following items before submitting a PR -- thank you!

If this PR tries to address multiple issues please split the PR out in a new
PR per feature/issue, unless that's not possible because of how the code builds
on top of each other. In that case ensure every feature/fix and its associated
tests and documentation are squashed into a distinct commit.

- [ ] 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 te 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

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.

0 comments on commit 5cb4cd6

Please sign in to comment.