Skip to content

docs(conventional-commit): Clarify AI footer #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Amygos wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(conventional-commit): Clarify AI footer #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 26 additions & 7 deletions skills/conventional-commit/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,24 @@ be author of a commit.
When AI tools contribute to development, proper attribution
helps track the evolving role of AI in the development process.

Contributions MUST include a Assisted-by tag in the following format::
Contributions MUST include an `Assisted-by` trailer in the following
format:

Assisted-by: AGENT_NAME:MODEL_VERSION

Where:

* ``AGENT_NAME`` is the name of the AI tool or framework
* ``MODEL_VERSION`` is the specific model version used
* ``MODEL_VERSION`` is the exact model label used for the session

Example:

Assisted-by: Copilot:gpt-54-mini
Assisted-by: Codex:GPT-5.5

Do not omit the `Assisted-by:` key. Do not shorten a point release or
user-visible model label, for example using `GPT-5` when the active
model is `GPT-5.5`. If the exact model label is unavailable or
contradicts the user-visible selector, ask the user before committing.

## Workflow

Expand Down Expand Up @@ -108,7 +114,8 @@ Analyze the diff to determine:

- **Type**: What kind of change is this?
- **Scope**: What area/module is affected?
- **Description**: One-line summary of what changed (present tense, imperative mood, <72 chars)
- **Description**: One-line summary of what changed (present tense,
imperative mood, short enough that the full subject is <=50 chars)

### 4. Execute Commit

Expand All @@ -120,13 +127,26 @@ git commit -m "<type>[scope]: <description>"
git commit -m "$(cat <<'EOF'
<type>[scope]: <description>

<body>
<body wrapped at 72 chars>

<optional footer>
EOF
)"
```

Do not pass long body paragraphs as single `-m` values. Git stores each
argument exactly as provided and does not wrap commit message text.

After committing, verify the message and amend immediately if it fails:

```bash
git show --format=%B --no-patch HEAD | awk '
NR == 1 && length($0) > 50 { print "subject >50: " length($0); bad=1 }
NR > 1 && length($0) > 72 { print "body >72: " length($0); bad=1 }
END { exit bad }
'
```

## Commit rules

- One logical change per commit
Expand All @@ -139,7 +159,7 @@ EOF
- Reference issues: `Closes #123`, `Refs #456`
- Always include a description body
- Use the body to explain what and why, not how
- Wrap the description body at 72 characters
- Wrap body and footer lines at 72 characters

## Git Safety Protocol

Expand All @@ -148,4 +168,3 @@ EOF
- NEVER skip hooks (--no-verify) unless user asks
- NEVER force push to main/master
- If commit fails due to hooks, fix and create NEW commit (don't amend)