diff options
| author | Luc Sinet <[email protected]> | 2021-07-11 15:35:08 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-07-11 09:35:08 -0400 |
| commit | ed382dd488cfa7e2f2c9fd907f096397e7fc644d (patch) | |
| tree | f42c6e198c134b61ffd6cca87e6ddf85dfe43fc4 | |
| parent | c6f831f5901bd04802f6dc857260229331e7dbee (diff) | |
Minimize the pull request template (#876)
Move the checklist section on top as a comment
| -rw-r--r-- | .github/pull_request_template.md | 32 |
1 files changed, 15 insertions, 17 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0ae48c6a..7b3a25f3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,3 +1,18 @@ +<!-- This won't be rendered! +[CHECKLIST] +I prefixed the title with one of the following tags: + - [Feature]: For feature addition / improvements + - [Bugfix]: When fixing a functionality + - [Refactor]: When moving code without adding any functionality + - [Doc]: On documentation updates + +- I read the contributing guide (CONTRIBUTING.md) +- My code follows the style guidelines of this project +- I have performed a self-review of my code +- I have commented on my code, particularly in hard-to-understand areas +- I have made corresponding changes to the documentation +- My changes generate no new warnings +--> # Description Please include a summary of the change and which issue is fixed. \ @@ -5,15 +20,6 @@ List any dependencies that are required for this change. Fixes #(issue) -## Type Of Change - -Please check the relevant options. - -- [ ] Bug fix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] This change requires a documentation update - ## How Has This Been Tested? Please describe the tests that you ran to verify your changes. \ @@ -24,11 +30,3 @@ Please also list any relevant details for your test configuration. - Check logs - ... -## Checklist: - -- [ ] I read the [contributing](https://github.com/ChristianChiarulli/LunarVim/blob/rolling/CONTRIBUTING.md) guide -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my code -- [ ] I have commented on my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings |