diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..a140b00e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,18 @@ +**Please check the type of change your PR introduces**: +- [ ] Bugfix +- [ ] Feature +- [ ] Code style update (formatting, renaming) +- [ ] Refactoring (no functional changes, no api changes) +- [ ] Build related changes +- [ ] Documentation content changes +- [ ] Other (please describe): + +**Issue Number** (if applicable): + +**Briefley outline your changes**: + +**Before submitting, please ensure that**: +- [ ] Must be backwards compatible +- [ ] All lint checks and tests must pass +- [ ] If a new option in the the config file is added, it needs to be added into the schema, and documented in the configuring guide +- [ ] If a new dependency is required, it must be essential, and it must be thoroughly checked out for security or efficiency issues