Instruct agents in git-commit.md and workflow-debugging/SKILL.md to use `Fixed:` rather than `Bug:` when a CL resolves an issue, reserving `Bug:` for CLs that are related without fully fixing the bug. TAG=agy CONV=7104f2d9-0fbf-420b-a2a4-cb945d590701 Change-Id: I1bcdcc7dcf3d8683ffc3a41c4acddedc5e713925 Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/8617103 Commit-Queue: Jakob Kummerow <jkummerow@chromium.org> Auto-Submit: Jakob Kummerow <jkummerow@chromium.org> Reviewed-by: Toon Verwaest <verwaest@chromium.org> Cr-Commit-Position: refs/heads/main@{#110966}
3.2 KiB
3.2 KiB
name, trigger
| name | trigger |
|---|---|
| git-commit | always_on |
Git Commit Conventions
These rules ensure correct formatting of commits and usage of standard Git commands in V8.
Commit Message Format
- Title: Must follow the format
[component] Title.- Keep the title short, concise, and punchy: aim for ~50 characters, and at
most 72 characters (including the
[component]prefix). Prefer high-level intent over verbose implementation details. - Use
[agents] titleONLY for changes to the agent automation suite itself.
- Keep the title short, concise, and punchy: aim for ~50 characters, and at
most 72 characters (including the
- Description: Keep the body concise (aim for at most 10 lines) and include
only essential information. Explain "why" and the high-level "what" without
restating details that are obvious from the diff. Focus on content, rationale,
and key non-obvious design decisions, not the process. Wrap lines at 72
characters.
- Maintain a cohesive summary: Rewrite or integrate new descriptions into a cohesive summary instead of simply appending them.
- Tone: Use concise, declarative, and natural engineering language.
- Tags: All tag-like lines (e.g.,
TAG=,BUG=,CONV=) must be at the very bottom of the CL description.- Always include
TAG=agyand the Conversation ID for agent-generated changes. - Ensure the
Change-Idfooter is preserved in the commit message. - Bug Lines:
- When a CL fixes a bug, write
Fixed: <bug_id>(e.g.,Fixed: 509339491). WriteBug:when the CL is related to a bug without fully resolving it. - For public bugs (e.g.,
issues.chromium.org), use the plain numerical bug ID ONLY (e.g.,Fixed: 509339491orBug: 509339491) without any prefix. - For internal bugs (e.g., Google-internal Buganizer), use the
b:prefix (e.g.,Fixed: b:349680002orBug: b:349680002). - When listing multiple bugs, limit bug listings to a maximum of 4 or 5 per
line (Gerrit stops rendering them as links). If you have more, add a
second
Fixed:orBug:line.
- When a CL fixes a bug, write
- Always include
Git Command Usage & Avoiding Interactive Hangs
- Ensure Non-Interactive Behavior: Jetski cannot interact with
terminal-based editors. Always run commands non-interactively.
- Bypass editors by prefixing with
EDITOR=true(e.g.,EDITOR=true git commit --amend). - Use
-mor-Ffor commit messages to avoid opening an editor. - Use
git --no-pagerorPAGER=catfor commands with long output (e.g.,git branch,git log).
- Bypass editors by prefixing with
- Timeout for Stuck Commands: If a git command does not show progress within 1 minute, kill the task and retry or report to the user.
- Branching: Create a new branch for unrelated changes. Keep changes focused and isolated to specific CLs. Preferably, inform the user about the unrelated changes and ask how they want to proceed (e.g., create new branch, discard, or hold) before uploading.
- Base on Clean Upstream: Base new branches on a clean upstream (e.g.,
origin/main, or the parent branch for stacked CLs). When creating a new worktree or branch (e.g., viaagents/scripts/create_worktree.sh <task_id> [base_branch]), always explicitly specify the base branch (defaulting toorigin/main) to ensure isolation from unrelated local commits.