agentleFS
nb-99nb-99/skillektion/skills/git-conventional-commits/SKILL.md

git-conventional-commits

Skill1 starsChanged 3 months agoMITView on GitHub

Use whenever committing in git.

6 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

6 rules. 0 are common, 2 are distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 4 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

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

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

    If the repo has a contribution guide (e.g.

    line 10
  2. Distinctive:

    If a change spans many unrelated areas, prefer splitting into multiple commits.

    line 38
  3. Very specific:

    If the work relates to a tracked issue, reference it in a footer rather than the subject: Refs: PROJ-1234 (Jira) or Refs: #123 …

    line 53
  4. Very specific:

    Use Closes #123 / Fixes #123 only when the commit actually resolves it and the platform supports auto-close.

    line 55
  5. Distinctive:

    Check recent git log to match the repo's existing type/scope conventions.

    line 64
  6. Very specific:

    Do not add Co-authored-by or tool attribution unless asked.

    line 66

“Common” is measured: kept by at least 6 in 10 of the 4 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

Conventional Commits

Format commit messages according to Conventional Commits 1.0.0.

If the repo has a contribution guide (e.g. CONTRIBUTING.md), its rules take precedence over this skill.

Structure

<type>(<optional scope>): <description>

<optional body>

<optional footer(s)>
  • description: imperative mood, lowercase, no trailing period, <= ~72 chars.
  • body: the why and what, not the how. Wrap at ~72 cols. Optional.
  • footer: Refs: DHEI-1234, Co-authored-by:, breaking-change note.

Allowed types

fix, feat, build, chore, ci, docs, style, refactor, perf, test.

Scope hints

  • The scope is an optional noun naming the affected area — typically a module, package, component, or subsystem in this repo.
  • Infer it from the touched path or the project's own convention (check recent git log for the scopes this repo already uses, and follow them).
  • If a change spans many unrelated areas, prefer splitting into multiple commits.
  • Omit the scope rather than invent a vague one.

Breaking changes

A breaking change is signalled by either:

  • ! after the type/scope: feat(api)!: drop v1 endpoints, or
  • a footer: BREAKING CHANGE: <explanation>.

Do not commit a breaking change autonomously — stop and ask for confirmation first.

Issue / ticket references

  • If the work relates to a tracked issue, reference it in a footer rather than the subject: Refs: PROJ-1234 (Jira) or Refs: #123 (GitHub/GitLab).
  • Use Closes #123 / Fixes #123 only when the commit actually resolves it and the platform supports auto-close.
  • For Jira tickets, follow the jira-workflow skill (e.g. ids like PROJ-1234); put the id in the footer, don't transition the ticket as a side effect.

Workflow

  1. Inspect git status and git diff --staged to ground the message in the actual change. Stage only intended files.
  2. Check recent git log to match the repo's existing type/scope conventions.
  3. Draft the message; never auto-commit — present it and ask to proceed.
  4. Do not add Co-authored-by or tool attribution unless asked.

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.