Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,34 @@ on:
- main

jobs:
check-commit-message:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v6
with:
fetch-depth: 0

- name: Check Commit Format
uses: gsactions/commit-message-checker@v2
with:
pattern: '^(EPMDEDP-\d+: (fix|feat|docs|style|refactor|test|chore)(!)?: .+|(chore|build)\(deps\): Bump .+)$'
error: 'Your commit message should be in the format "EPMDEDP-ID: type: Description". Example: "EPMDEDP-16058: feat: add feature"'
excludeDescription: 'true'
excludeTitle: 'true'
checkAllCommitMessages: 'true'
accessToken: ${{ secrets.GITHUB_TOKEN }}

- name: Check Line Length
uses: gsactions/commit-message-checker@v2
with:
pattern: '^.{10,72}$'
error: 'The maximum line length of 72 characters is exceeded.'
excludeDescription: 'true'
excludeTitle: 'false'
checkAllCommitMessages: 'true'
accessToken: ${{ secrets.GITHUB_TOKEN }}

test:
name: Test
runs-on: ubuntu-latest
Expand Down
28 changes: 24 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,31 @@ While the prerequisites above must be satisfied prior to having your pull reques

### Git Commit Messages

Commit messages **must** follow the platform format for Jira traceability and changelog generation:

**Format:** `EPMDEDP-<ID>: <type>: <description>`

**Example:** `EPMDEDP-16058: feat: add feature`

**Allowed types:**

| Type | Purpose |
|----------|----------------------------|
| feat | New feature |
| fix | Bug fix |
| docs | Documentation changes |
| style | Code style/formatting |
| refactor | Code refactoring |
| test | Adding/updating tests |
| chore | Maintenance tasks |

Use the `!` suffix after the type for breaking changes (e.g. `feat!: change API`).

**Additional guidelines:**

Automated dependency update commits are also allowed in the format `chore(deps): Bump <dependency> ...`.

* Use the present tense ("Add feature" not "Added feature")
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
* Limit the first line to 72 characters or less
* Reference issues and pull requests liberally after the first line
* Follow the conventional commits format. For example:
* `feat: Add new feature`
* `fix: Fix issue with login`
* `docs: Update README with usage instructions`
Loading