Permalink
Browse files

github: small improvements pull request template

  • Loading branch information...
markus2330 committed Jun 24, 2018
1 parent 96d7ebb commit d1d8ff0ef784076646d3c173c1958bb6f3092e61
Showing with 19 additions and 9 deletions.
  1. +19 −9 .github/PULL_REQUEST_TEMPLATE.md
@@ -1,20 +1,30 @@
# Purpose
## Basics
Describe the purpose of the pull request.
Long descriptions should be in documentation and not here.
Do not describe the purpose here but:
# Checklist
- [ ] Short descriptions should be in the release notes (added as entry in
doc/news/_preparation_next_release.md which contains `*(my name)*`)
**Please always add something to the the release notes.**
- [ ] Longer descriptions should be in documentation or in design decisions.
- [ ] Describe details of how you changed the code in commit messages
(first line should have `module: short statement` syntax)
- [ ] References to issues, e.g. `close #X`, should be in the commit messages.
Check relevant points but please do not remove entries.
For docu fixes, spell checking, and similar nothing
needs to be checked.
## Checklist
Check relevant points but **please do not remove entries**.
For docu fixes, spell checking, and similar none of these points below
need to be checked.
- [ ] commit messages are fine ("module: short statement" syntax and refer to issues)
- [ ] I added unit tests
- [ ] I ran all tests locally and everything went fine
- [ ] affected documentation is fixed
- [ ] I added code comments, logging, and assertions (see doc/CODING.md)
- [ ] meta data is updated (e.g. README.md of plugins)
- [ ] release notes are updated (doc/news/_preparation_next_release.md)
## Review
Remove the line below and add the "work in progress" label if you do
not want the PR to be reviewed:
@markus2330 please review my pull request

0 comments on commit d1d8ff0

Please sign in to comment.