diff options
author | Linnea Gräf <nea@nea.moe> | 2024-03-17 16:41:51 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-03-17 16:41:51 +0100 |
commit | 7ce1b9dce8785fbe6a52ccc3030bf9afd1753fb4 (patch) | |
tree | 62bfe5a17bc43df5368ff2a264cc6f2b3890ee21 | |
parent | e3ded1d8f1de558aafb785e2d7dbccf2b31782f0 (diff) | |
download | NotEnoughUpdates-7ce1b9dce8785fbe6a52ccc3030bf9afd1753fb4.tar.gz NotEnoughUpdates-7ce1b9dce8785fbe6a52ccc3030bf9afd1753fb4.tar.bz2 NotEnoughUpdates-7ce1b9dce8785fbe6a52ccc3030bf9afd1753fb4.zip |
Add PR naming convention (#1051)
-rw-r--r-- | .github/pull_request_template.md | 19 | ||||
-rw-r--r-- | .github/workflows/enforce-pr-name.yml | 19 |
2 files changed, 38 insertions, 0 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..6218fe34 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,19 @@ +<!-- + +Thank you for choosing to contribute to NEU! + +Please make sure to give your PR a descriptive title. + +Your PR title will be used in our changelog and should look like one of those: + +Add fleebleblub menu +Fix crash in the gorp overlay +meta: Remove outdated documentation in CONTRIBUTING.md + +Use the meta prefix for things that don't affect users and use Add, Fix, or Remove for the rest of your PR. + +Do not end your PR title with a . + +If your PR bundles two features, consider opening two PRs, one for each instead. + +--> diff --git a/.github/workflows/enforce-pr-name.yml b/.github/workflows/enforce-pr-name.yml new file mode 100644 index 00000000..cd848845 --- /dev/null +++ b/.github/workflows/enforce-pr-name.yml @@ -0,0 +1,19 @@ +on: + pull_request: + types: + - opened + - edited + - synchronize + - reopened + +name: Naming conventions +jobs: + verify-pr-name: + name: Check PR name + runs-on: ubuntu-latest + steps: + - uses: deepakputhraya/action-pr-title@master + with: + regex: '(meta: )?(Add|Fix|Remove) .+[^\\.]' + prefix_case_sensitive: true + github_token: ${{ github.token }} |