diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE new file mode 100644 index 0000000..aa0f2ee --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE @@ -0,0 +1,47 @@ +# Pull Request Guidelines + +Our guidelines for submitting a pull request. + +## Before submitting a Pull Request, please make sure you have verified the following: + +- [ ] The commit message follows our guidelines: + - A good commit message should be two things: meaningful and concise. It should not contain every single detail, describing each changed line—we can see all the changes in Git—but, at the same time, it should say enough to avoid ambiguity. + - We use Microverse's commit message convention + - The convention stablish that a commit message has to be in the present tense, imperative and lowercase. + - Example: `fix typo in README.md` +- [ ] Tests for the changes have been added (for bug fixes / features) +- [ ] Docs have been added / updated (for bug fixes / features) + +## PR Type + +What kind of change does this PR introduce? + + +- [ ] Bugfix +- [ ] Feature +- [ ] Code style update (formatting, local variables) +- [ ] Refactoring (no functional changes, no api changes) +- [ ] Build related changes +- [ ] CI related changes +- [ ] Other... Please describe: + +## What is the current behavior? + +Please describe the current behavior that you are modifying, or link to a relevant issue. + +Issue Number: N/A + +## What is the new behavior? + +Describe the new behavior or link to a relevant issue. + +## Does this PR introduce a breaking change? + +- [ ] Yes +- [ ] No + +If this PR contains a breaking change, please describe the impact and migration path for existing applications below. + +## Other information + +Any other information that is important to this PR.