Draft Commit

Draft a Commit Message

Draft a commit message proposal in Markdown based on the current changes or the context provided by the user. Produce text only. Do not run git commit, do not amend commits, and do not change git state.

When to Use

• Draft a commit message for the current working tree.
• Turn a code change into a release-note-friendly summary.
• Prepare a commit message for a GitHub issue fix.
• Refine an existing rough commit title or body.

Output Requirements

• Return the draft as Markdown.
• Put the full commit message in a fenced code block so the user can review it easily.
• Do not execute git commit or any other git write operation.
• If the available information is incomplete, state the assumptions briefly before the code block.
• When the draft mentions program names, commands, file paths, code identifiers, or HTML/CSS syntax, use inline backticks appropriately.
• End the commit message with one Git trailer that records AI assistance, following AI_POLICY.md. Use Assisted-by: AGENT_NAME:MODEL_VERSION when the tool and model are known, with the model version written in lowercase, hyphen-separated words (no spaces). If only the tool is known, use Assisted-by: AGENT_NAME; if neither is known, use Assisted-by: AI assistance. Never invent tool names, model names, or versions. Do not add a Co-authored-by: trailer naming the AI. The user may add or correct this information before creating the actual commit.

Example trailers:

Assisted-by: GitHub Copilot Chat:gpt-5.6-luna

Title Rules

• Start the title with a conventional commit type such as fix:, feat:, docs:, refactor:, test:, or chore:.
• For changes in packages/core, use the plain type prefix without a scope, such as fix: or feat:.
• For changes centered on packages other than core, include that package as the scope, such as fix(viewer): or feat(react):.
• After the type prefix, start the description with an uppercase letter.
• Make the title explain what bug was fixed or what feature was implemented.
• Prefer wording that is clear in release notes or changelogs.
• Keep the title specific to the user-visible outcome, not just the internal implementation detail.

Examples:

• fix: Fix WPT test failures for embedded HTML content
• fix(viewer): Fix page navigation state sync
• feat: Add support for semantic footnote call markers

Body Rules

• Explain what was changed and how it was implemented.
• Focus on the main behavior change, root cause, or implementation approach.
• Keep the body concise but informative.
• If there is a related issue or PR that is not closed by the commit, include an appropriate reference such as Refs #1914, Related to #1914, or See PR #1234.
• If the change resolves a GitHub issue, end the body with Closes #1914 using the relevant issue number, then append the AI-assistance trailers.

Procedure

1. Gather context from the user's prompt and, when needed, inspect the current git changes with read-only commands or tools.
2. Infer the best conventional commit type from the nature of the change.
3. Identify the user-visible fix or feature and express that in the title.
4. Summarize the key implementation details in the body.
5. If the work resolves a GitHub issue, append a final line like Closes #1914. Otherwise, add a related issue or PR reference when that context is relevant.
6. Append the single Assisted-by trailer after a blank line, in the AGENT_NAME:MODEL_VERSION format (model version in lowercase, hyphen-separated words). Include the AI tool name and model version only when known; use the appropriate fallback when some or all of this information is unavailable. The user may complete or correct this trailer before creating the actual commit.
7. Return only the draft and any brief assumptions needed for review.

Decision Rules

• Use fix: for bug fixes, regressions, compatibility fixes, or test-failure fixes tied to broken behavior.
• Use feat: for new behavior or newly supported capability.
• Use refactor: when behavior is unchanged but the implementation is meaningfully reworked.
• Use docs:, test:, or chore: only when the change is primarily documentation, tests, or maintenance.
• If the change spans multiple categories, choose the type that best matches the main user-facing outcome.
• If the change is mainly in packages/viewer or packages/react, include that package name as the scope.
• If the change is mainly in packages/core, omit the scope.

Quality Check

Before returning the draft, verify that:

• The title begins with a valid conventional prefix.
• The first word after the prefix starts with an uppercase letter.
• The title states the fix or feature clearly enough for release notes.
• The body explains the actual change rather than repeating the title.
• Related issues or PRs are referenced when useful, and Closes #... is used only when the commit actually closes the issue.
• Program names, commands, code identifiers, and HTML/CSS terms are wrapped in inline backticks where appropriate.
• The issue-closing line is present only when the change actually closes a GitHub issue.
• The commit ends with exactly one Assisted-by Git trailer after a blank line, in the AGENT_NAME:MODEL_VERSION format (model version in lowercase, hyphen-separated words, no spaces).
• The trailer uses the verified AI tool name and model information when available, and does not replace the commit body.
• Missing AI tool or model information is acceptable in the draft because the user may add it before committing.
• No Co-authored-by: trailer names the AI.
• The response contains a draft only and does not perform git commit.