Commit b5a0a39
Changed files (1)
lib
jive
templates
lib/jive/templates/pull_request_template.md
@@ -1,41 +1,51 @@
# Pull Request Template
-## Description
+## Why is this needed?
-Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+## What does this do?
+
+<!--
+ Include a summary of the change and which issue is fixed.
+ Include relevant motivation and context.
+ List any dependencies that are required for this change.
+-->
Fixes # (issue)
+### Screenshots
+
+Before:
+
+![before]()
+
+After:
+
+![after]()
+
## Type of change
-Please delete options that are not relevant.
+Delete options that are not relevant.
- [ ] 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?
+## Verification Plan
-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 are we going to verify this change?
-- [ ] Test A
-- [ ] Test B
+- [ ] Step 1
+- [ ] Step 2
-**Test Configuration**:
-* Firmware version:
-* Hardware:
-* Toolchain:
-* SDK:
+## Checklist
-## Checklist:
+- [ ] Clear description explaining the relevancy of the contribution.
+- [ ] Unit, integration, and system tests.
+- [ ] Regression and bugs are covered with tests.
+- [ ] [Performance guidelines][performance]
+- [ ] [Secure coding guidelines][secure]
+- [ ] Documentation Updated
-- [ ] My code follows the style guidelines of this project
-- [ ] I have performed a self-review of my own code
-- [ ] I have commented my code, particularly in hard-to-understand areas
-- [ ] I have made corresponding changes to the documentation
-- [ ] My changes generate no new warnings
-- [ ] I have added tests that prove my fix is effective or that my feature works
-- [ ] New and existing unit tests pass locally with my changes
-- [ ] Any dependent changes have been merged and published in downstream modules
-- [ ] I have checked my code and corrected any misspellings
+[performance]: https://docs.gitlab.com/ee/development/merge_request_performance_guidelines.html
+[secure]: https://docs.gitlab.com/ee/development/secure_coding_guidelines.html