Skip to content

Commit 841833e

Browse files
authored
fix: pr-title-jira-key workflow example (#3481)
1 parent ed3846a commit 841833e

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

.github/workflows/pr-title-jira-key-lint.yml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,14 @@ jobs:
2828
2929
Your PR title doesn't contain a Jira issue key. Consider adding it for better traceability.
3030
31-
**Examples:**
31+
**Example:**
3232
- \`feat: add user authentication (CDP-123)\`
33-
- \`fix(CDP-123): resolve login issue\`
34-
33+
- \`feat: add user authentication (IN-123)\`
34+
35+
**Projects:**
36+
- CDP: Community Data Platform
37+
- IN: Insights
38+
3539
Please add a Jira issue key to your PR title.`;
3640
3741
github.rest.issues.createComment({

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ This project uses [Conventional Commits](https://www.conventionalcommits.org/) e
156156

157157
**PR Title Requirements:**
158158
- Must follow conventional commit format: `type(scope): description`
159-
- Should include JIRA ticket key in title: `feat(CDP-123): add new feature`
159+
- Should include JIRA ticket key in title: `feat: add new feature (CDP-123)`
160160

161161
**PR Process:**
162162
1. Ensure your commits follow the conventional commit format

0 commit comments

Comments
 (0)