agentleFS
alfredobs97alfredobs97/flutter_agentic_template/.agents/skills/conventional-commits/SKILL.md

conventional-commits

Skill0 starsChanged 51 days agoMITView on GitHub

Explains the Conventional Commits format used in this repo, the standard commit types with worked examples using this repo's real scopes, the breaking-change footer, and how types map to semver; load before writing a commit message.

56 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use github, grilling and 7 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.
  • NVIDIASkill

    github

    Interact with GitHub using the gh CLI restricted to REST API only (no GraphQL). Use when the user wants to work with GitHub issues, pull requests, repos, releases, or Actions — especially in sandboxed environments where the GraphQL endpoint may be blocked. Trigger keywords - github, gh, pull request, PR, github issue, github actions, workflow, release, gh api.

    Also in 3 projects that use this

  • GoogleSkill

    grilling

    Grill the user relentlessly about a plan, decision, or idea. Use when the user wants to stress-test their thinking, or uses any 'grill' trigger phrases.

    Also in 5 projects that use this

  • NVIDIASkill

    research

    Before designing a feature, research how comparable libraries solve the problem, check best practices, known pitfalls, and upstream changes. Use when starting a new feature, investigating an unfamiliar area, or the user asks to research something.

    Also in 5 projects that use this

  • GoogleSkill

    wayfinder

    Plan a huge chunk of work — more than one agent session can hold — as a shared map of decision tickets on your issue tracker, and resolve them one at a time until the way to the destination is clear.

    Also in 3 projects that use this

  • SentrySkill

    skill-creator

    Create new agent skills following the Agent Skills specification. Use when asked to "create a skill", "add a new skill", "write a skill", "make a skill", "build a skill", or scaffold a new skill with SKILL.md. Guides through requirements, writing, registration, and verification.

    Also in 5 projects that use this

  • MicrosoftSkill

    handoff

    Compact the current conversation into a handoff document for another agent to pick up.

    Also in 3 projects that use this

  • +3 more from google

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 51 edited versions we read keep these.

  • 1

    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:

    Every commit message in this repo follows the Conventional Commits format:

    line 8
  2. Very specific:

    If a change fits two types, pick the one that describes its primary intent — a bug fix that happens to add a regression test is still fix, …

    line 49

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

Every commit message in this repo follows the Conventional Commits format:

<type>(<scope>): <subject>

[optional body]

[optional footer(s)]
  • <type> — what kind of change this is (see the table below).
  • <scope> — the part of the codebase the change lives in, in parentheses, lowercase. In this repo the scopes that map to something real are: domain, data, ui (the three packages/), tool (the tool/ scripts — quality_gate.dart, check_architecture.dart, sync_ai_config.dart), ai (the ai/ source files that sync_ai_config.dart generates from), and docs (AGENTS.md, README.md, skill files). A change spanning more than one package (a new feature touching domain, data and ui together) either picks the layer most central to the change or omits the scope entirely — don't invent a scope like feature or app that doesn't correspond to a real directory.
  • <subject> — imperative mood, lowercase, no trailing period: add task list screen, not Added the task list screen..

Standard types, with real-repo examples

TypeUse forExample
featA new capability visible to a user or consumer of the packagefeat(ui): add task list screen
fixA bug fix — behavior was wrong, now it's correctfix(data): map DriftTimeoutException to ConnectivityFailure
refactorRestructuring code with no behavior changerefactor(domain): extract sortedTasks getter onto Task
testAdding or fixing tests only, no production code changetest(data): cover ApiTaskDataProvider's 404 mapping
docsDocumentation only — AGENTS.md, README.md, skill files, doc commentsdocs(ai): clarify when to add a DomainFailure subtype
choreMaintenance with no source or behavior impact (dependency bump, gitignore entry)chore(ui): bump go_router to 17.4.0
ciContinuous-integration configurationci(tool): run quality_gate.dart on pull_request
buildBuild system or packaging (Gradle, Xcode project, pubspec structure)build(domain): add domain as a workspace member
perfA change made specifically to improve performance, with no behavior changeperf(ui): gate AnimationController.repeat on TickerMode
styleFormatting/whitespace only — never a lint fix that changes logicstyle(data): run dart format -l 100 on failure_guard.dart

If a change fits two types, pick the one that describes its primary intent — a bug fix that happens to add a regression test is still fix, not test.

Breaking changes

A change that breaks an existing public API (a domain entity's constructor signature, a data_provider interface method, an exported Cubit's public method) is marked one of two ways:

  • ! after the type/scope, for a short, self-explanatory break:

    feat(domain)!: require ClockReader in TaskRepository's constructor
  • A BREAKING CHANGE: footer, when the break needs its own explanation (what broke, and what callers must do about it):

    refactor(domain): rename Task.due to Task.dueAt
    
    BREAKING CHANGE: Task.due is renamed to Task.dueAt to match the
    ValidationFailure message key. Update every constructor call and
    copyWith usage in data and ui.

Both forms can be combined (! in the header, plus a BREAKING CHANGE: footer with the detail) when the one-line summary in the header isn't enough on its own.

Mapping to semver

Conventional Commits exists so a release tool can derive the next version number from commit history without a human deciding it by hand:

Commit containsSemver bump
Only fix, refactor, test, docs, chore, ci, build, perf, stylepatch (0.1.0 → 0.1.1)
At least one featminor (0.1.0 → 0.2.0)
Any commit with ! or a BREAKING CHANGE: footer, regardless of typemajor (0.1.0 → 1.0.0)

A feat! or a fix with a BREAKING CHANGE: footer both trigger a major bump — the breaking-change marker outranks the type it's attached to.

Write the message for the reader, not for yourself

A commit message should describe the change's effect — what a caller, reviewer, or future archaeologist of git log needs to know — not restate the diff. fix(data): handle timeout in ApiTaskDataProvider is worse than fix(data): map DriftTimeoutException to ConnectivityFailure so the UI shows the offline message instead of a generic error only in length, not in substance: prefer the version that says why the change matters, but keep the subject line itself short and put the "why" in the body when it doesn't fit in one line. Never write a subject that just paraphrases the file list (fix(data): update failure_guard.dart) — that information is already in git show --stat.

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.