Skip to content
Open
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
13 changes: 2 additions & 11 deletions .github/pr-title-checker-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,11 @@
"color": "EEEEEE"
},
"CHECKS": {
"prefixes": [
"LCORE-",
"RSPEED-",
"MGTM-",
"OLS-",
"RHIDP-",
"LEADS-",
"CWFHEALTH-",
"[release/"
]
"regexp": "^(LCORE|RSPEED|MGTM|OLS|RHIDP|LEADS|CWFHEALTH)-[1-9]\\d*[: ]|^\\[release/"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[medium] pattern-inconsistency

The regexp requires [: ] immediately after the issue number, so a bare key like LCORE-123 with no trailing colon or space is rejected. This is stricter than the old prefixes mode. Ensure this is intentional.

Suggested fix: If bare JIRA keys without a description should be allowed, change [: ] to ([: ]|$) in the regexp.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[medium] pattern-inconsistency

The regex enforces a [: ] delimiter (colon or space) immediately after the issue number, but none of the four documentation files (AGENTS.md, CONTRIBUTING.md, contributing_guidelines.md, contributing_guide.md) mention this requirement. A title like LCORE-1234-fix-bug would be silently rejected by the regex despite appearing to satisfy the documented rules.

Suggested fix: Either add a note to the documentation (e.g. The JIRA key must be followed by a colon or space) or relax the regex delimiter.

},
"MESSAGES": {
"success": "All OK",
"failure": "Failing CI test",
"failure": "Failing CI test — PR title must start with a valid JIRA key (e.g. LCORE-1234) or [release/",
"notice": ""
}
}
11 changes: 9 additions & 2 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -412,11 +412,18 @@ uv run make test-e2e # End-to-end tests

## Pull Request Requirements

**PR titles MUST start with a JIRA issue key prefix.** CI enforces this via `pr-title-checker` (config: `.github/pr-title-checker-config.json`).
**PR titles MUST start with a valid JIRA issue key (project prefix + non-zero issue number).** CI enforces this via `pr-title-checker` (config: `.github/pr-title-checker-config.json`).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] doc-style

The updated text says Placeholder keys like LCORE-0000 or LCORE-0 are rejected, but the regexp also rejects keys with leading zeros (e.g. LCORE-0123). Minor documentation omission.


Allowed prefixes: `LCORE-`, `RSPEED-`, `MGTM-`, `OLS-`, `RHIDP-`, `LEADS-`, `CWFHEALTH-`, `[release/`
- Allowed project prefixes: `LCORE`, `RSPEED`, `MGTM`, `OLS`, `RHIDP`, `LEADS`, `CWFHEALTH`
- The issue number after the prefix must be a positive integer (e.g. `LCORE-1234`)
- Placeholder keys like `LCORE-0000` or `LCORE-0` are rejected, as are keys with leading zeros (e.g. `LCORE-0123`)
- The JIRA key must be followed by a colon or space (e.g. `LCORE-1234: description` or `LCORE-1234 description`)
- Release branch PRs may use the `[release/` prefix instead

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] doc-style

The Allowed project prefixes block is a single ~330-character paragraph packing three separate constraints (valid prefixes, positive-integer rule, leading-zero rejection) into one run-on sentence, whereas surrounding AGENTS.md sections use short bullet lists or numbered lists.

- ✅ `RSPEED-2849: add user_agent to ResponsesEventData`
- ✅ `[release/0.8] cherry-pick fix`
- ❌ `LCORE-0000: placeholder key`
- ❌ `LCORE-1234-fix-bug` (missing colon or space after the key)
- ❌ `feat(observability): add user_agent to ResponsesEventData`

## Development Workflow
Expand Down
16 changes: 11 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,11 +111,17 @@ Happy hacking!

## PR description

* PR titles must start with a JIRA issue key prefix or the target branch of a backport in brackets. CI enforces this via
`pr-title-checker` (config: `.github/pr-title-checker-config.json`).
Allowed prefixes: `LCORE-`, `RSPEED-`, `MGTM-`, `OLS-`, `RHIDP-`, `LEADS-`,
`CWFHEALTH-`, `[release/`
- for example: `LCORE-740: type hints for models unit tests`
* PR titles must start with a valid JIRA issue key (project prefix + non-zero issue number) or
the target branch of a backport in brackets. CI enforces this via `pr-title-checker`
(config: `.github/pr-title-checker-config.json`).
Allowed project prefixes: `LCORE`, `RSPEED`, `MGTM`, `OLS`, `RHIDP`, `LEADS`,
`CWFHEALTH`. The issue number must be a positive integer (e.g. `LCORE-1234`).
Placeholder keys like `LCORE-0000` or `LCORE-0` are rejected, as are keys with
leading zeros (e.g. `LCORE-0123`). The JIRA key must be followed by a colon or
space (e.g. `LCORE-1234: description`). Release branch PRs may use the `[release/`
prefix instead.
- ✅ `LCORE-740: type hints for models unit tests`
- ❌ `LCORE-0000: placeholder key`
* Fill-in all relevant information in the PR template
- unused parts of PR template (like information about testing etc.) can be deleted
* Please note that CodeRabbitAI will create a summary of your pull request
Expand Down
16 changes: 11 additions & 5 deletions docs/demos/lcore/contributing_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,17 @@ ptisnovs@redhat.com

## PR description

* PR titles must start with a JIRA issue key prefix. CI enforces this via
`pr-title-checker` (config: `.github/pr-title-checker-config.json`).
Allowed prefixes: `LCORE-`, `RSPEED-`, `MGTM-`, `OLS-`, `RHIDP-`, `LEADS-`,
`CWFHEALTH-`, `[release/`
- for example: `LCORE-740: type hints for models unit tests`
* PR titles must start with a valid JIRA issue key (project prefix + non-zero issue number).
CI enforces this via `pr-title-checker`
(config: `.github/pr-title-checker-config.json`).
Allowed project prefixes: `LCORE`, `RSPEED`, `MGTM`, `OLS`, `RHIDP`, `LEADS`,
`CWFHEALTH`. The issue number must be a positive integer (e.g. `LCORE-1234`).
Placeholder keys like `LCORE-0000` or `LCORE-0` are rejected, as are keys with
leading zeros (e.g. `LCORE-0123`). The JIRA key must be followed by a colon or
space (e.g. `LCORE-1234: description`). Release branch PRs may use the `[release/`
prefix instead.
- ✅ `LCORE-740: type hints for models unit tests`
- ❌ `LCORE-0000: placeholder key`
* Fill-in all relevant information in the PR template
- unused parts of PR template (like information about testing etc.) can be deleted
* Use tags if you need/want to!
Expand Down
16 changes: 11 additions & 5 deletions docs/devel_doc/contributing_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,17 @@ Happy hacking!

## PR description

* PR titles must start with a JIRA issue key prefix or the target branch of a backport. CI enforces this via
`pr-title-checker` (config: `.github/pr-title-checker-config.json`).
Allowed prefixes: `LCORE-`, `RSPEED-`, `MGTM-`, `OLS-`, `RHIDP-`, `LEADS-`,
`CWFHEALTH-`, `[release/`
- for example: `LCORE-740: type hints for models unit tests`
* PR titles must start with a valid JIRA issue key (project prefix + non-zero issue number) or
the target branch of a backport. CI enforces this via `pr-title-checker`
(config: `.github/pr-title-checker-config.json`).
Allowed project prefixes: `LCORE`, `RSPEED`, `MGTM`, `OLS`, `RHIDP`, `LEADS`,
`CWFHEALTH`. The issue number must be a positive integer (e.g. `LCORE-1234`).
Placeholder keys like `LCORE-0000` or `LCORE-0` are rejected, as are keys with
leading zeros (e.g. `LCORE-0123`). The JIRA key must be followed by a colon or
space (e.g. `LCORE-1234: description`). Release branch PRs may use the `[release/`
prefix instead.
- ✅ `LCORE-740: type hints for models unit tests`
- ❌ `LCORE-0000: placeholder key`
* Fill-in all relevant information in the PR template
- unused parts of PR template (like information about testing etc.) can be deleted
* Please note that CodeRabbitAI will create a summary of your pull request
Expand Down
Loading