From 917263c9e4f53376036af94d192cdb2fe9d91e3e Mon Sep 17 00:00:00 2001 From: wernerr Date: Mon, 22 Aug 2022 08:47:55 +0200 Subject: [PATCH] Improve pull request template --- .github/pull_request_template.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6dcf9497..5c34c374 100644 --- 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 - +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) - +## 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/ \ No newline at end of file +- [ ] 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/