Skip to main content

commit

Commit message formatting and guidelines

Stars
53,746
Source
TryGhost/Ghost
Updated
2026-05-30
Slug
TryGhost--Ghost--commit
View on GitHubRaw SKILL.md

// install — copy + paste into any project

mkdir -p .claude/skills && curl -fsSL https://raw.githubusercontent.com/TryGhost/Ghost/HEAD/.agents/skills/commit/SKILL.md -o .claude/skills/commit.md

Drops the SKILL.md into .claude/skills/commit.md. Works with Claude Code, Cursor, and any agent that loads SKILL.md files from .claude/skills/.

Commit

Use this skill whenever the user asks you to create a git commit for the current work.

Instructions

  1. Review the current git state before committing:
    • git status
    • git diff
    • git log -5 --oneline
  2. Only stage files relevant to the requested change. Do not include unrelated untracked files, generated files, or likely-local artifacts.
  3. Read and follow .github/CONTRIBUTING.md#commit-messages. It is the source of truth for Ghost's commit conventions.
  4. For publishable packages, check whether a release intent is required. A package README.md is published and requires a release; repository-only Markdown such as AGENTS.md, changelogs, and package-local docs/ does not.
  5. Run git status --short after committing and confirm the result.

Important

  • Do not push to remote unless the user explicitly asks
  • Keep commits focused and avoid bundling unrelated changes
  • If there are no relevant changes, do not create an empty commit
  • If hooks fail, fix the issue and create a new commit. Never bypass hooks.