From 543ac4aa8dd969d503dfffde408580cf7e3d905a Mon Sep 17 00:00:00 2001 From: Juan Luis Baptiste Date: Sat, 22 May 2021 20:09:19 -0500 Subject: [PATCH] Added a pull request template --- .github/pull_request_template.md | 36 ++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..e623af5 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,36 @@ +# Creating a Pull Request + +We use github actions to do automatic [semantic versioning](https://github.com/semantic-release/semantic-release), so please use the following nomenclature for the commit message according to the type of change: + +* Prefix with `feat:`, and it will trigger a minor version bump. +* Prefix with `fix`:, and it will trigger a patch version bump. +* Prefix with `BREAKING CHANGE:`, and it will trigger a major version bump. + +## Description of the change + + + + + +## Motivation and Context + + + +## How Has This Been Tested? + + + +## Types of Changes + +- [ ] 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) +- [ ] Documentation (adding or updating documentation) + +## Checklist: + + +- [ ] My change requires a change to the documentation and I have updated the documentation accordingly. +- [ ] My change adds a new configuration variable and I have updated the `.env.example` file accordingly. + +And lastly, many thanks for taking your time to help us improve this project !