diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..6688fc2e1a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,24 @@ +## Description + +Closes: #XXXX + + + +--- + +### Author Checklist + +*All items are required. Please add a note to the item if the item is not applicable and +please add links to any relevant follow up issues.* + +I have... + +- [ ] ran linting +- [ ] wrote tests where necessary +- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title +- [ ] targeted the correct branch +- [ ] provided a link to the relevant issue or specification +- [ ] reviewed "Files changed" and left comments if necessary +- [ ] confirmed all CI checks have passed +- [ ] added an entry to the `CHANGELOG.md` file \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index dd28bcc46c..0000000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,17 +0,0 @@ - - -## Description - - - -## Checklist -- [ ] Ran Linting -- [ ] Targeted PR against correct branch. -- [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work. -- [ ] Wrote unit tests. -- [ ] Added an entry to the `CHANGELOG.md` file. -- [ ] Re-reviewed `Files changed` in the Github PR explorer. diff --git a/.github/workflows/lint-pr.yml b/.github/workflows/lint-pr.yml new file mode 100644 index 0000000000..912e3a4b20 --- /dev/null +++ b/.github/workflows/lint-pr.yml @@ -0,0 +1,20 @@ +name: "Lint PR" +# Lint PR workflow runs linting over a single PR in order to make sure that the title respects +# the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. +# This workflow is run every time a PR is opened, edited or updated somehow. + +on: + pull_request_target: + types: + - opened + - edited + - synchronize + +jobs: + Lint: + runs-on: ubuntu-latest + steps: + - name: Run lint ✅ + uses: amannn/action-semantic-pull-request@v4.5.0 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file