agentleFS
termio-shtermio-sh/termio/skills/conventional-commit/SKILL.md

conventional-commit

Skill787 starsChanged 3 months agoMITView on GitHub

Conventional Commit - Generate Conventional Commits 1.0.0 compliant messages. MANDATORY for all git commits. Invoke when user says 'commit', 'commit this', or asks to commit code.

30 other projects use a version of this, 1 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use shipping-and-launch, doubt-driven-development and 9 more.

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.
  • LLl0k0laDSkill

    shipping-and-launch

    Use when preparing to deploy to production. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy.

    Also in 3 projects that use this

  • seikaikyoSkill

    doubt-driven-development

    對非平凡決策啟動新鮮 context 對抗審查(找碴不背書),在修正還便宜的時候抓出錯誤方向。適用:高風險改動(production、資安敏感邏輯、不可逆操作)、不熟的程式碼、要宣稱「這樣是安全的 / 可行的」之前。機械性操作與一行修改不適用。

    Also in 3 projects that use this

  • LLl0k0laDSkill

    api-and-interface-design

    Use when designing APIs, module boundaries, or any public interface. Use when creating REST or GraphQL endpoints, defining type contracts between modules, or establishing boundaries between frontend and backend.

    Also in 3 projects that use this

  • HK-hubSkill

    code-simplification

    Simplifies code for clarity. Use when refactoring code for clarity without changing behavior. Use when code works but is harder to read, maintain, or extend than it should be. Use when reviewing code that has accumulated unnecessary complexity.

    Also in 3 projects that use this

  • guaderramaSkill

    spec-driven-development

    Generate comprehensive specifications for software projects using spec-driven development methodology. Leverages Bright Data MCP tools to research documentation, analyze competitor implementations, gather real-world examples, and enrich specs with architectural insights. Use when user requests specifications, technical plans, project specs, or architecture documentation.

    Also in 3 projects that use this

  • MicrosoftSkill

    api-design

    Guide for designing and documenting RESTful APIs. Use when asked to design an API, create endpoints, or document an API.

    Also in 3 projects that use this

  • +1 more from LLl0k0laD

The file

We split this skill into the rules it gives an agent

8 rules. 0 are common, 7 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 27 edited versions we read keep these.

  • 7

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When the user asks to commit changes:

    line 22
  2. Distinctive:

    Add "BREAKING CHANGE:" footer for detailed explanation

    line 46
  3. Distinctive:

    Create commit with the generated message

    line 57
  4. Distinctive:

    DO NOT: add any Claude Code references, co-author tags, or "Generated with" footers

    line 59
  5. Very specific:

    NEVER include AI-generated markers, Claude Code references, or Co-Authored-By: Claude footers

    line 69
  6. Distinctive:

    If changes are complex or ambiguous, ask the user:

    line 132
  7. Distinctive:

    If there are breaking changes

    line 135
  8. Distinctive:

    If they want to split into multiple commits (encouraged by spec)

    line 136

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

Generate commit messages following the Conventional Commits 1.0.0 specification.

Commit Message Structure

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Instructions

When the user asks to commit changes:

  1. Analyze the changes by running:
    • git status to see all modified/added/deleted files
    • git diff --staged to see staged changes
    • git diff to see unstaged changes
    • git log -5 --oneline to match the repository's commit style
  2. Determine the commit type (REQUIRED):
    TypeDescriptionSemVer
    featNew featureMINOR
    fixBug fixPATCH
    docsDocumentation only-
    styleFormatting, no code change-
    refactorCode change, no feature/fix-
    perfPerformance improvement-
    testAdding/updating tests-
    buildBuild system or dependencies-
    ciCI configuration-
    choreOther changes-
  3. Identify breaking changes:
    • Append "!" after type/scope for breaking changes: "feat!:" or "feat(api)!:"
    • Add "BREAKING CHANGE:" footer for detailed explanation
    • Breaking changes trigger MAJOR version bump
  4. Write the commit message:
    • Description MUST immediately follow the colon and space
    • Description is a short summary in imperative mood
    • Body MUST begin one blank line after description
    • Footers MUST begin one blank line after body
  5. Stage and commit:
    • Stage relevant files with git add
    • Create commit with the generated message
    • Show git status after to confirm success
    • DO NOT add any Claude Code references, co-author tags, or "Generated with" footers

Specification Rules

  • Type MUST be a noun (feat, fix, etc.)
  • Scope MUST be a noun in parentheses describing codebase section
  • Description MUST use imperative mood ("add" not "added")
  • Body is free-form, may have multiple paragraphs
  • Footer token MUST use - instead of spaces (except BREAKING CHANGE)
  • BREAKING CHANGE MUST be uppercase
  • NEVER include AI-generated markers, Claude Code references, or Co-Authored-By: Claude footers

Examples

Feature with breaking change footer

feat: allow provided config object to extend other configs

BREAKING CHANGE: `extends` key in config file is now used for extending other config files

Breaking change with !

feat(api)!: send an email to the customer when a product is shipped

Breaking change with exclamation mark and footer

chore!: drop support for Node 6

BREAKING CHANGE: use JavaScript features not available in Node 6.

Simple docs change (no body)

docs: correct spelling of CHANGELOG

Feature with scope

feat(lang): add Polish language

Fix with multi-paragraph body and footers

fix: prevent racing of requests

Introduce a request id and a reference to latest request. Dismiss
incoming responses other than from latest request.

Remove timeouts which were used to mitigate the racing issue but are
obsolete now.

Reviewed-by: Z
Refs: #123

Revert commit

revert: let us never again speak of the noodle incident

Refs: 676104e, a215868

Footer Formats

Footers follow git trailer format:

  • Token: value or Token #value
  • Common footers: Refs:, Closes:, Reviewed-by:, Co-authored-by:
  • BREAKING CHANGE: description for breaking changes

Interactive Mode

If changes are complex or ambiguous, ask the user:

  • Which files to include in the commit
  • What type of change this represents
  • If there are breaking changes
  • If they want to split into multiple commits (encouraged by spec)

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.