diff options
Diffstat (limited to '.github/pull_request_template.md')
| -rw-r--r-- | .github/pull_request_template.md | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7b3a25f3..48782e51 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,12 +1,12 @@ <!-- 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 + - feature: for feature addition / improvements + - fix: when fixing a functionality + - refactor: when moving code without adding any functionality + - doc: on documentation updates -- I read the contributing guide (CONTRIBUTING.md) +- I read the contributing guide [CONTRIBUTING.md](../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 @@ -15,17 +15,17 @@ I prefixed the title with one of the following tags: --> # Description -Please include a summary of the change and which issue is fixed. \ -List any dependencies that are required for this change. +summary of the change -Fixes #(issue) +<!--- Please list any dependencies that are required for this change. ---> -## How Has This Been Tested? +fixes #(issue) -Please describe the tests that you ran to verify your changes. \ -Provide instructions so we can reproduce. \ -Please also list any relevant details for your test configuration. +## How Has This Been Tested? +<!--- Please describe the tests that you ran to verify your changes. ---> +<!--- Also list any relevant details for your test configuration. ---> +<!--- Provide instructions so we can reproduce --> - Run command `:mycommand` - Check logs - ... |