summaryrefslogtreecommitdiffstats
path: root/.github/PULL_REQUEST_TEMPLATE.md
AgeCommit message (Collapse)Author
2017-11-28release-notes: use CHANGELOG.mdGravatar Lubomir I. Ivanov
Add a file CHANGELOG.md in the root Subsurface directory and track this file with the `-text merge=union` attribute. This prevents merge conflicts if release notes are added on top of the file by different commits. Also, make ReleaseNotes/ReleaseNotes.txt point to that file. Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
2017-11-16github: update PR template with 'documentation-change'Gravatar Lubomir I. Ivanov
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>
2017-11-16github: improve the issue templateGravatar Lubomir I. Ivanov
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-09-26github: add templates for pull requests and issue reportsGravatar Lubomir I. Ivanov
.github/ISSUE_TEMPLATE.md will be used when the Github users create new issues. .github/PULL_REQUEST_TEMPLATE.md will be used when the Github users create new pull requests. The markdown supports HTML comments (<!-- comment -->), which can instruct the Github user how to create a detailed PR or issue report. Most big Github projects use such templates and these can help the collaborators to examine the PRs and ISSUES faster. Fixes #598 Reviewed-by: Dirk Hohndel <dirk@hohndel.org> Reviewed-by: Jan Mulder <jlmulder@xs4all.nl> Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com> Signed-off-by: Miika Turkia <miika.turkia@gmail.com>