diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..c107bc35 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ +## What is the purpose of the change + +For example: Making PowerJob better + +## Brief changelog + +It is best to associate an existing issue + +## Verifying this change + +Do I need to test? +Has testing been completed? +Test method? + +Follow this checklist to help us incorporate your contribution quickly and easily. Notice, `it would be helpful if you could finish the following 3 checklist before request the community to review your PR`. + +- [x] Make sure there is a [Github issue](https://github.com/PowerJob/PowerJob/issues) filed for the change (usually before you start working on it). Trivial changes like typos do not require a Github issue. Your pull request should address just this issue, without pulling in other changes - one PR resolves one issue. +- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why. +- [x] Follow the git commit specification + * feat: xxx -> The feat type is used to identify production changes related to new backward-compatible abilities or functionality. + * perf: xxx -> The perf type is used to identify production changes related to backward-compatible performance improvements. + * fix: xxx -> The fix type is used to identify production changes related to backward-compatible bug fixes. + * docs: xxx -> The docs type is used to identify documentation changes related to the project - whether intended externally for the end users (in case of a library) or internally for the developers. + * test: xxx -> The test type is used to identify development changes related to tests - such as refactoring existing tests or adding new tests. + * refactor: xxx -> The refactor type is used to identify development changes related to modifying the codebase, which neither adds a feature nor fixes a bug - such as removing redundant code, simplifying the code, renaming variables, etc. + + \ No newline at end of file