[replay #7427] docs: define how to pick a PR title's type and scope - #13
[replay #7427] docs: define how to pick a PR title's type and scope#13sshiv012 wants to merge 4 commits into
Conversation
Closes apache#7393 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Yicong Huang <17627829+Yicong-Huang@users.noreply.github.com>
…ne rework by user-facing behavior
📝 WalkthroughWalkthroughContribution templates and documentation now provide expanded Conventional Commits guidance. The updates cover scopes, change types, tests, dependencies, CI, release branches, and refactor test assertions. ChangesContribution guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
@coderabbitai review |
✅ Action performedReview finished.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@AGENTS.md`:
- Around line 172-178: Update the GitHub Actions row in the Dependencies
commit-convention table to distinguish CVE-patching updates from all other
Actions bumps: document `fix(deps, ci): ...` for CVE patches and retain
`chore(deps, ci): ...` otherwise, matching the existing dependency-bump
guidance.
In `@CONTRIBUTING.md`:
- Around line 63-69: Update the Markdown tables in the contribution guidance
around the change-type table and the other affected table to use leading-only
pipes: remove the trailing `|` from every row in both table sections while
preserving their contents and alignment.
In `@docs/contribution-guidelines/_index.md`:
- Around line 72-75: Clarify the dependency-bump example in the PR title
guidance by either replacing `chore(deps): bump dependency versions` with a
module-scoped example or explicitly labeling it as a cross-module bump. Keep the
surrounding scope rules consistent with the documented exception for
cross-module changes.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: dd465964-203f-4e27-81d2-18b42f76bf45
📒 Files selected for processing (4)
.github/PULL_REQUEST_TEMPLATEAGENTS.mdCONTRIBUTING.mddocs/contribution-guidelines/_index.md
| **Dependencies.** `fix` only when the bump carries a security fix: | ||
|
|
||
| | Bump | Commit | | ||
| | --- | --- | | ||
| | Patches a CVE | `fix(deps, <module>): ...` | | ||
| | Everything else | `chore(deps, <module>): ...` | | ||
| | GitHub Actions | `chore(deps, ci): ...` | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Add the CVE exception to the GitHub Actions row.
Line 172 says that fix applies to security bumps, but Line 178 lists GitHub Actions updates as chore(deps, ci) without an exception. This conflicts with CONTRIBUTING.md Line 86 and docs/contribution-guidelines/_index.md Line 100. A contributor can select chore for a CVE-patching Actions update and miss fix-specific backport automation. Add the fix(deps, ci) form for CVE patches.
Proposed documentation fix
-| GitHub Actions | `chore(deps, ci): ...` |
+| GitHub Actions | `chore(deps, ci): ...`, or `fix(deps, ci): ...` when the bump patches a CVE |As per coding guidelines, classify dependency bumps as fix only when they patch a CVE and use chore otherwise.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **Dependencies.** `fix` only when the bump carries a security fix: | |
| | Bump | Commit | | |
| | --- | --- | | |
| | Patches a CVE | `fix(deps, <module>): ...` | | |
| | Everything else | `chore(deps, <module>): ...` | | |
| | GitHub Actions | `chore(deps, ci): ...` | | |
| **Dependencies.** `fix` only when the bump carries a security fix: | |
| | Bump | Commit | | |
| | --- | --- | | |
| | Patches a CVE | `fix(deps, <module>): ...` | | |
| | Everything else | `chore(deps, <module>): ...` | | |
| | GitHub Actions | `chore(deps, ci): ...`, or `fix(deps, ci): ...` when the bump patches a CVE | |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@AGENTS.md` around lines 172 - 178, Update the GitHub Actions row in the
Dependencies commit-convention table to distinguish CVE-patching updates from
all other Actions bumps: document `fix(deps, ci): ...` for CVE patches and
retain `chore(deps, ci): ...` otherwise, matching the existing dependency-bump
guidance.
Source: Coding guidelines
| | Your change | Type | | ||
| | ----------- | ---- | | ||
| | A functionality worked before and no longer does | `fix` | | ||
| | A functionality or a form of support never existed and you are adding it | `feat` | | ||
| | A functionality exists and you are removing support for it | `feat` | | ||
| | A functionality is reworked in a way that intentionally changes user-facing behavior | `feat` | | ||
| | The change leaves the user-facing behavior unchanged | `refactor` | |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the Markdown table style reported by markdownlint-cli2.
MD055 reports trailing pipes in both changed tables. Remove the final | from every row in Lines 63-69 and Lines 79-84 because the configured style is leading-only.
Proposed Markdown fix
-| Your change | Type |
-| ----------- | ---- |
+| Your change | Type
+| ----------- | ----Also applies to: 79-84
🧰 Tools
🪛 markdownlint-cli2 (0.23.2)
[warning] 63-63: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
[warning] 64-64: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
[warning] 65-65: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
[warning] 66-66: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
[warning] 67-67: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
[warning] 68-68: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
[warning] 69-69: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.md` around lines 63 - 69, Update the Markdown tables in the
contribution guidance around the change-type table and the other affected table
to use leading-only pipes: remove the trailing `|` from every row in both table
sections while preserving their contents and alignment.
Source: Linters/SAST tools
| - `chore(deps): bump dependency versions` | ||
| - The PR title becomes the final squashed commit message upon merge. | ||
|
|
||
| A scope names the module the change lands in — `amber`, `pyamber`, `frontend`, `agent-service`, `file-service`, and so on. Use the module's own name rather than an informal synonym, and when a PR spans modules, scope it to the one carrying the substantive change. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Clarify the unscoped dependency example.
Line 72 shows a bare chore(deps) title. Lines 75 and 93-100 require a module scope for module-specific dependency bumps. Line 100 allows omitting the module only for cross-module bumps. Replace the example with a module-scoped form or state that it represents a cross-module bump.
Proposed documentation fix
- - `chore(deps): bump dependency versions`
+ - `chore(deps, pyamber): bump numpy to version 2.0.0`📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - `chore(deps): bump dependency versions` | |
| - The PR title becomes the final squashed commit message upon merge. | |
| A scope names the module the change lands in — `amber`, `pyamber`, `frontend`, `agent-service`, `file-service`, and so on. Use the module's own name rather than an informal synonym, and when a PR spans modules, scope it to the one carrying the substantive change. | |
| - `chore(deps, pyamber): bump numpy to version 2.0.0` | |
| - The PR title becomes the final squashed commit message upon merge. | |
| A scope names the module the change lands in — `amber`, `pyamber`, `frontend`, `agent-service`, `file-service`, and so on. Use the module's own name rather than an informal synonym, and when a PR spans modules, scope it to the one carrying the substantive change. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/contribution-guidelines/_index.md` around lines 72 - 75, Clarify the
dependency-bump example in the PR title guidance by either replacing
`chore(deps): bump dependency versions` with a module-scoped example or
explicitly labeling it as a cross-module bump. Keep the surrounding scope rules
consistent with the documented exception for cross-module changes.
2 participants
Replay of apache#7427 for CodeRabbit evaluation.
merge-base
5e41efae2650head5cc5ff3adab1stratumworkflowsSynthetic evaluation PR. Do not merge.