diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8b8f5684..bd4d16f2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,19 @@ + + ### Summary of Changes _Include a summary of changes then remove this line_ @@ -11,11 +27,13 @@ _What tests did you add or modify and why? If no tests were added or modified, e _What documentation did you add or modify and why? Add any relevant links then remove this line_ ### CheckList + Make sure you have checked **all** steps below to ensure a timely review. + - [ ] PR title addresses the issue accurately and concisely. Example: "Updates the version of Flask to v1.0.2" - - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x). -- [ ] PR includes a summary of changes. -- [ ] PR adds unit tests, updates existing unit tests, __OR__ documents why no test additions or modifications are needed. + - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x). +- [ ] PR includes a summary of changes. +- [ ] PR adds unit tests, updates existing unit tests, **OR** documents why no test additions or modifications are needed. - [ ] In case of new functionality, my PR adds documentation that describes how to use it. - - All the public functions and the classes in the PR contain docstrings that explain what it does + - All the public functions and the classes in the PR contain docstrings that explain what it does - [ ] PR passes `make test` diff --git a/.github/prlint.json b/.github/prlint.json deleted file mode 100644 index ea3f83a1..00000000 --- a/.github/prlint.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "title": [ - { - "pattern": "^(build|ci|docs|feat|fix|perf|refactor|style|test|chore|other)((.+))?:\\s.+", - "message": "Your title needs to be prefixed with a topic." - } - ], - "body": [ - { - "pattern": ".{1,}", - "message": "You need literally some contents in your description" - } - ] -} diff --git a/.github/titleLint.yml b/.github/titleLint.yml new file mode 100644 index 00000000..b1457621 --- /dev/null +++ b/.github/titleLint.yml @@ -0,0 +1 @@ +regex: (build|ci|docs|feat|fix|perf|refactor|style|test|chore|other): .*