mirror of
https://github.com/subsurface/subsurface.git
synced 2024-11-28 13:10:19 +00:00
adb0adb1d2
Add a 'Documentation change' section to the PR body. This instructs the PR submitter to edit the section with notes for the team editing the documentation. If a PR has such notes, a maintainer should then apply the needs-documentation-change label, so that the documentation team can easily filter such PRs by label. Suggested-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
39 lines
1.6 KiB
Markdown
39 lines
1.6 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. -->
|
|
|
|
### Documentation change:
|
|
<!-- If this PR makes changes to user functionality, then the documentation has to be updated too. -->
|
|
<!-- Please, briefly outline here what has changed in terms of the user experience (UX). -->
|
|
<!-- If UX changes have been made, a maintainer should apply the 'needs-documentation-change' label. -->
|
|
|
|
### Mentions:
|
|
<!-- Mention users that you want to review your pull request with @<user-name>. Leave empty if not sure. -->
|