Skip to content

Commit f9c8b33

Browse files
committed
[MINOR] Update PR message requirements
1 parent c13754c commit f9c8b33

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

.github/workflows/commit_checks.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ jobs:
1818
- name: Check Commit Format
1919
uses: gsactions/commit-message-checker@v2
2020
with:
21-
pattern: 'Issue \#[0-9]+: .+'
21+
pattern: '((Issue \#[0-9]+:)|(\[((\#[0-9]+)|(MINOR)|(AUTO))\])) .+'
2222
checkAllCommitMessages: 'true'
23-
error: 'Your first line has to have the format "Issue #XXX: Commit message".'
23+
error: 'Your first line has to have the format "Issue #XXX: Commit message" or "[#XXX] Commit Message".'
2424
excludeDescription: 'true'
2525
excludeTitle: 'true'
2626
accessToken: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Pull requests must adhere to style guidelines enforced by a variety of tools. De
88
- Black formatter (88 column line default)
99
- Ruff linter
1010
- isort import organizer
11-
- Commit message requirements: Must take the form `Issue #XXX: Commit message`, not exceeding 72 characters.
11+
- Commit message requirements: Must take the form `[#XXX] Commit message`, not exceeding 72 characters.
1212

1313
It is recommended to install these tools in the editor of your choice and have them warn for noncompliance and apply autofixes on save.
1414

0 commit comments

Comments
 (0)