diff options
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE.md')
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 33 |
1 files changed, 9 insertions, 24 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 89b548554..e75bbcd60 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,17 +1,6 @@ -[TIP]: # ( Provide a general summary of your changes in the title above ^^ ) - -## Type of change -[NOTE]: # ( Please remove all lines which don't apply. ) -- ✅ Bug fix (non-breaking change which fixes an issue) -- ✅ Refactor (significant modification to existing code) -- ✅ New feature (non-breaking change which adds functionality) -- ✅ Breaking change (fix or feature that would cause existing functionality to change) -- ✅ Documentation (non-code change) - -## Description and Context [NOTE]: # ( Describe your changes in detail, why is this change required? ) -[NOTE]: # ( Describe the context of your change. Explain large code modifications. ) -[NOTE]: # ( If it fixes an open issue, please add "Fixes #XXX" as necessary ) +[NOTE]: # ( Explain large or complex code modifications. ) +[NOTE]: # ( If it fixes an open issue, please add "Fixes #XXX" ) ## Screenshots @@ -23,14 +12,10 @@ [TIP]: # ( We expect new code to be covered by unit tests and documented with doc blocks! ) -## Checklist: -[NOTE]: # ( Please go over all the following points. ) -[NOTE]: # ( Again, remove any lines which don't apply. ) -[NOTE]: # ( Pull Requests that don't fulfill all [REQUIRED] requisites are likely ) -[NOTE]: # ( to be sent back to you for correction or will be rejected. ) -- ✅ I have read the **CONTRIBUTING** document. **[REQUIRED]** -- ✅ My code follows the code style of this project. **[REQUIRED]** -- ✅ All new and existing tests passed. **[REQUIRED]** -- ✅ I have compiled and verified my code with `-DWITH_ASAN=ON`. **[REQUIRED]** -- ✅ My change requires a change to the documentation, and I have updated it accordingly. -- ✅ I have added tests to cover my changes. +## Type of change +[NOTE]: # ( Please remove all lines which don't apply. ) +- ✅ Bug fix (non-breaking change that fixes an issue) +- ✅ New feature (change that adds functionality) +- ✅ Breaking change (causes existing functionality to change) +- ✅ Refactor (significant modification to existing code) +- ✅ Documentation (non-code change) |