Docs: Clarify contribution requirements

[ci skip]
This commit is contained in:
Jared Beck 2018-11-02 17:54:38 -04:00
parent c77ee68e63
commit 1fe58215f4
3 changed files with 42 additions and 4 deletions

View File

@ -7,6 +7,18 @@ about: >
---
Thank you for your contribution!
Due to limited volunteers, issues that do not follow these instructions will be
closed without comment.
Check the following boxes:
- [ ] This is not a usage question, this is a bug report
- [ ] I am committed to fixing this bug myself, I just need some help
- [ ] This bug can be reproduced with the script I provide below
- [ ] This bug can be reproduced in the latest release of the `paper_trail` gem
Due to limited volunteers, we cannot answer *usage* questions. Please ask such
questions on [StackOverflow](https://stackoverflow.com/tags/paper-trail-gem).

View File

@ -7,16 +7,28 @@ about: >
---
Due to limited volunteers, we cannot answer *usage* questions. Please ask such
questions on [StackOverflow](https://stackoverflow.com/tags/paper-trail-gem).
Thank you for your contribution!
Due to limited volunteers, issues that do not follow these instructions will be
closed without comment.
Check the following boxes:
- [ ] I am committed to building this feature myself
- [ ] I will respond to feedback, and build this feature, in a reasonable amount
of time
**Is your feature suggestion related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always
frustrated when [...]
A clear and concise description of the problem. You may find the
[bug report template](https://github.com/paper-trail-gem/paper_trail/blob/master/.github/ISSUE_TEMPLATE/bug_report.md)
helpful.
**Describe the solution you'd like to build**
A clear and concise description of what you want to build.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've
considered.

14
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,14 @@
Thank you for your contribution!
Check the following boxes:
- [ ] Wrote [good commit messages][1].
- [ ] Feature branch is up-to-date with `master` (if not - rebase it).
- [ ] Squashed related commits together.
- [ ] Added tests.
- [ ] Added an entry to the [Changelog](../blob/master/CHANGELOG.md) if the new
code introduces user-observable changes.
- [ ] The PR relates to *only* one subject with a clear title
and description in grammatically correct, complete sentences.
[1]: http://chris.beams.io/posts/git-commit/