agentleFS
TheophilusChinomonaTheophilusChinomona/idev/skills/commit-style/SKILL.md

commit-style

Skill0 starsChanged 5 months agoMITView on GitHub

Team commit-message conventions. Use when writing a commit message, committing or amending changes, or when asked about the project's commit format. Reads the per-project style from .claude/idev/commit-style.md.

  • Commits and pushes

10 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use release.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • MicrosoftSkill

    release

    Use ONLY when the user explicitly asks to cut/publish a Huabu desktop release or tag a version. Performs an outward action — bumps the version in apps/desktop/package.json, commits + annotated-tags vX.Y.Z, and pushes the branch + tag. That tag push auto-builds the macOS/Windows installers and publishes a GitHub Release. Provides `status`, `bump`, `tag-push`, and a one-command `run` (bump → tag-push).

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 0 are distinctive, and 5 are very specific to this project.

  • 0

    Common

    Most of the 8 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 5

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Write commit messages that pass the team's commit-msg hook on the first try and read well in git log years later.

    line 8
  2. Very specific:

    If it exists, its rules override everything below.

    line 14
  3. Very specific:

    Derive the ticket ID from the branch name: when the style requires one: git branch --show-current, extract the first ABC-123-shaped token.

    line 18
  4. Very specific:

    Check before committing: if .git/hooks/commit-msg exists, the message must match its pattern (default: optional ABC-123: ticket prefix + …

    line 32
  5. Very specific:

    When creating a PR (any platform — az repos pr create on Azure DevOps, gh pr create on GitHub), unless .claude/idev/commit-style.md …

    line 50

“Common” is measured: kept by at least 6 in 10 of the 8 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Commit Style — Team Commit Message Conventions

Write commit messages that pass the team's commit-msg hook on the first try and read well in git log years later.

Procedure

  1. Read the project's style file first: .claude/idev/commit-style.md. If it exists, its rules override everything below. If it doesn't exist, apply the defaults below (and mention that /idev:hooks install-git-hooks sets up the style file + enforcement hooks).
  2. Derive the ticket ID from the branch name when the style requires one: git branch --show-current, extract the first ABC-123-shaped token. The prepare-commit-msg hook does this automatically too — don't add the prefix twice.
  3. Write the message:
    • Subject: type(scope): imperative summary — conventional-commit types (feat, fix, docs, refactor, perf, test, build, ci, chore), ≤ 72 chars, no trailing period.
    • Body (for anything non-trivial): the why, not a list of what — the diff already shows what. Wrap at ~72 columns.
    • Trailers last, each on its own line (Co-Authored-By:, Refs:), per the team's policy in the style file.
  4. Check before committing: if .git/hooks/commit-msg exists, the message must match its pattern (default: optional ABC-123: ticket prefix + conventional-commit subject). If the hook rejects a commit, fix the message — never bypass with --no-verify unless the user explicitly asks.

Defaults (when no style file exists)

feat(auth): add refresh-token rotation

Sessions died after 15 minutes because the access token was never
refreshed. Rotate the refresh token on each renewal per OWASP.

Refs: ABC-123

Pull request format

When creating a PR (any platform — az repos pr create on Azure DevOps, gh pr create on GitHub), unless .claude/idev/commit-style.md overrides:

  • Title: same convention as the commit subject (ticket prefix + typed imperative summary). For a single-commit branch, reuse the subject.
  • Description:
## What
2-4 bullets of user-visible change (not a commit list — the platform shows those).

## Why
The problem/ticket context in 1-3 sentences.

## Testing
What was actually run: build, tests, browser-test report path if UI.

## Notes for reviewer
Risky spots, decisions needing eyes, rollback hint. Omit if none.

Anti-patterns

  • "fix stuff", "wip", "updates" — the hook rejects these; so should you.
  • Restating the diff in the body.
  • Bundling unrelated changes to share one message — split the commits.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.