OpenParable
Skip to content
← Back to skills

Conventional Commits

Development
conventional-commits

Conventional Commits is an Agent Skill for development published in the Xe/site repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use when creating git commits, writing commit messages, or following version control workflows

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/Xe/site/blob/HEAD/.agents/skills/conventional-commits/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/conventional-commits, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Conventional Commits

Structured commit message format for version control that provides clear, readable project history.

Overview

The Conventional Commits specification provides:

  • Automated changelog generation - Tools can parse commits to generate CHANGELOG.md
  • Semantic versioning - Commit types map to version bumps (feat → minor, breaking → major)
  • Clear project history - Standardized format makes git log readable
  • Automated releases - CI/CD can trigger releases based on commit types

Quick Reference

TypeUse ForVersion Bump
featNew featureMINOR
fixBug fixPATCH
docsDocumentation onlyPATCH
styleFormatting, no logic changePATCH
refactorCode restructuring, no behavior changePATCH
perfPerformance improvementPATCH
testAdding or updating testsPATCH
buildBuild system or dependenciesPATCH
ciCI/CD configurationPATCH
choreMaintenance, no user-facing changePATCH
revertRevert a previous commitPATCH

Format

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Rules:

  • Type is required
  • Scope is optional - use parenthesized section affected: (api), auth), parser)
  • Description is required
  • Keep description concise, imperative mood, lowercase, no trailing period
  • Body and footer are optional
  • Separate subject from body with blank line
  • Wrap body at 72 characters

Examples

feat: add user authentication

Implement JWT-based authentication with login/logout endpoints.
Includes password hashing and session management.

Closes: #123
fix(api): handle null response from server

Previous implementation crashed when server returned null.
Now returns empty result set.

Assisted-by: GLM 4.6 via Claude Code
feat(storage)!: change bucket listing API

BREAKING CHANGE: bucket list now returns async iterator
instead of array. Update all callers to use for-await.
refactor(core): simplify error handling

Consolidate duplicate error handlers into single utility.
No behavior changes - internal cleanup only.
revert: feat(auth): add OAuth support

This reverts commit 8b5a1c2. OAuth provider changed
their API and we need to redesign integration.

Breaking Changes

Indicate breaking changes in two ways:

Option 1: Add ! after type/scope

feat(api)!: remove deprecated endpoint

Option 2: Add BREAKING CHANGE: footer

feat(api): remove deprecated endpoint

BREAKING CHANGE: endpoint no longer exists. Use newEndpoint instead.

AI Attribution

AI agents must disclose their assistance in the commit footer:

Assisted-by: [Model Name] via [Tool Name]

Examples:

  • Assisted-by: GLM 4.6 via Claude Code
  • Assisted-by: Claude Opus 4.5 via claude.ai

Common Mistakes

MistakeWhy WrongCorrect
Added login featurePast tense, capitalizedfeat: add login feature
fix bug.Trailing periodfix: resolve login error
updateMissing typechore: update dependencies
feature:add-authMissing space after colonfeat: add authentication
FEAT: big changeUppercase typefeat: add authentication
Multi-line description no blank lineNo separationAdd blank line after subject

Body Guidelines

  • What: Motivation for the change (vs. code comments describe HOW)
  • Contrast: Explain the WHY and WHAT, not code details
  • Wrap at 72 characters for readability in git log
feat(summarization): add support for nested bullet points

Previous implementation only flattened all content. Now preserves
hierarchy by respecting indentation levels. Users can now create
structured summaries with parent-child relationships.

Closes: #456

Footer Guidelines

Use footers for:

  • Breaking changes: BREAKING CHANGE: detailed explanation
  • Issue references: Closes: #123, Fixes: #456, Refs: #789
  • AI attribution: Assisted-by: Model via Tool

Multiple footers separated by blank lines:

feat: add batch upload

Implements multipart upload for large files.

BREAKING CHANGE: upload() signature changed - now requires options object
Closes: #123
Assisted-by: GLM 4.6 via Claude Code

Git Commit Flags

Required flag: Always use --signoff when committing:

git commit --signoff -m "feat: add user authentication"

The --signoff flag adds a Signed-off-by trailer to the commit message, indicating the committer has certified the commit follows developer certificate of origin (DCO).

Testing Your Commit

Before committing, verify:

  1. Type is from allowed list
  2. Description is imperative mood (add, fix, update)
  3. Description is lowercase
  4. No trailing period on description
  5. Breaking changes marked with ! or footer
  6. AI attribution included (if applicable)
  7. Body explains WHY not HOW
  8. Using --signoff flag