Improve pull request template

gofiber · Aug 22, 2022 · f9e8709 · f9e8709 · ReneWerner87 · Aug 22, 2022
1 parent c964fda
commit f9e8709
Showing 1 changed file with 26 additions and 6 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,11 +1,31 @@
-**Please provide enough information so that others can review your pull request:**
+## Description
 
-<!-- You can skip this if you're fixing a typo or adding an app to the Showcase. -->
+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. 
+Explain the *details* for making this change. What existing problem does the pull request solve?
 
-**Explain the *details* for making this change. What existing problem does the pull request solve?**
+Fixes # (issue)
 
-<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
+## Type of change
 
-**Commit formatting** 
+Please delete options that are not relevant.
 
-Use emojis on commit messages so it provides an easy way of identifying the purpose or intention of a commit. Check out the emoji cheatsheet here: https://gitmoji.carloscuesta.me/
+- [ ] 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
+
+## Checklist:
+
+- [ ] For new functionalities I follow the inspiration of the express js framework and built them similar in usage
+- [ ] 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 - https://github.com/gofiber/docs for https://docs.gofiber.io/
+- [ ] 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
+- [ ] If new dependencies exist, I have checked that they are really necessary and agreed with the maintainers/community (we want to have as few dependencies as possible)
+- [ ] I tried to make my code as fast as possible with as few allocations as possible
+- [ ] For new code I have written benchmarks so that they can be analyzed and improved
+
+## Commit formatting:
+
+Use emojis on commit messages so it provides an easy way of identifying the purpose or intention of a commit. Check out the emoji cheatsheet here: https://gitmoji.carloscuesta.me/