subsurface/.github/PULL_REQUEST_TEMPLATE.md
Lubomir I. Ivanov 6632c263d9 github: improve the issue template
1) Add new description types:
- 'Code cleanup'
- 'Build system change'

2) Add a 'Release note' section:
The idea with this is that if you make a change
which is worthy of a release note in ReleaseNotes.txt,
it would be best to outline it here but also in the .txt.

This basically means that the PR should also touch
ReleaseNotes.txt with an extra patch.

Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
2017-11-16 08:38:57 +01:00

35 lines
1.3 KiB
Markdown

<!-- Lines like this one are comments and will not be shown in the final output. -->
<!-- Make sure that you have read the "Contributing" section of the README and also the notes in CodingStyle. -->
<!-- If you are a collaborator, please add labels and assign other collaborators for a review. -->
### Describe the pull request:
<!-- Replace [ ] with [x] to select options. -->
- [ ] Bug fix
- [ ] Functional change
- [ ] New feature
- [ ] Code cleanup
- [ ] Build system change
- [ ] Documentation change
- [ ] Language translation
### Pull request long description:
<!-- Describe your pull request in detail. -->
### Changes made:
<!-- Enumerate the changes with 1), 2), 3) etc. -->
<!-- Ensure the test cases are updated if needed. -->
### Related issues:
<!-- Reference issues with #<issue-num>. -->
<!-- Write "Fixes #<issue-num" to notify Github that this PR fixes an issue. -->
### Additional information:
<!-- Include sample dive log or other relevant information to allow testing the change where feasible. -->
### Release note:
<!-- Describe if this change needs a release note present in ReleaseNotes/ReleaseNotes.txt. -->
<!-- Also, please make sure to update the ReleaseNotes/ReleaseNotes.txt file itself. -->
### Mentions:
<!-- Mention users that you want to review your pull request with @<user-name>. Leave empty if not sure. -->