agentleFS
EndogenAIEndogenAI/dogma/.github/skills/conventional-commit/SKILL.md

conventional-commit

Skill2 starsChanged 8 months agoApache-2.0View on GitHub

Enforces Conventional Commits format for the EndogenAI Workflows repository. USE FOR: composing commit messages (type(scope): description format); reviewing commit message format before push; understanding allowed types (feat/fix/docs/chore/test/refactor/ci/perf) and scopes (scripts/agents/docs/tests/ci/deps/research). DO NOT USE FOR: release versioning decisions (use the Release Manager agent); PR template authoring.

30 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use shipping-and-launch, doubt-driven-development and 10 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

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

  • 0

    Common

    Most of the 27 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    No period at the end of the description

    line 27

“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

This skill enacts the Algorithms Before Tokens axiom from MANIFESTO.md by encoding commit message conventions as a reusable procedure, eliminating per-session re-prompting overhead. Commit discipline is governed by AGENTS.md § Commit Discipline and CONTRIBUTING.md § Commit Discipline. When this skill and those documents conflict, the primary documents take precedence.


1. Format

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

[optional body]

[optional footer(s)]

Rules for the first line:

  • Imperative mood: "add", "fix", "update" — not "adds", "fixed", "updating"
  • Lowercase throughout (type, scope, description)
  • No period at the end of the description
  • Maximum 72 characters for the first line
  • Scope is in parentheses, not brackets

Valid: docs(guides): add session-management skill reference Invalid: Updated the docs. / DOCS: Updates guides / docs(guides): Added session-management skill reference.


2. Types

TypeWhen to useExample for this repo
featNew capability, new agent, new scriptfeat(agents): add executive-docs agent
fixCorrection to existing content or codefix(scripts): handle missing .tmp dir in prune_scratchpad
docsDocumentation only — no code or script changedocs(guides): clarify encoding checkpoint format
choreTooling, scripts, templates, config — no production logicchore(scripts): add scaffold_workplan.py for plan generation
testNew or updated teststest(scripts): add coverage for validate_synthesis error cases
refactorRestructuring without content or behaviour changerefactor(agents): extract session-mgmt handoff to skill
ciCI configuration, workflow files, pre-commit hooksci: add validate_skill_files check to lint job
perfPerformance improvementperf(scripts): cache URL validation results in fetch_source

Do not use feat for documentation. A new research doc is docs(research), not feat(research). A new guide is docs(guides).


3. Scopes

Scopes are lowercase, single-word identifiers describing the affected area of the codebase:

ScopeCovers
scriptsFiles in scripts/
agentsFiles in .github/agents/
skillsFiles in .github/skills/
docsFiles in docs/ (guides, research, plans, decisions)
testsFiles in tests/
ciFiles in .github/workflows/, .pre-commit-config.yaml
depspyproject.toml, uv.lock, dependency changes
researchResearch synthesis docs in docs/research/
plansWorkplan docs in docs/plans/
manifestoMANIFESTO.md changes
readmeREADME.md changes
guidesSpecific use when only docs/guides/ files change

Scope is optional but strongly encouraged for this repo — it makes git log --oneline readable and enables filtered history queries (e.g., git log --oneline -- scripts/).


4. Multi-Line Body Format

For commits that benefit from explanation (why, not just what), add a body after a blank line:

docs(agents): add session-management skill body section

The session-close procedure previously lacked the issue-comment step.
Added steps 6.2 and 6.3 to encode the gh issue comment + checkbox update
sequence from AGENTS.md § Agent Communication.

Closes #42

Body guidelines:

  • Separate from the first line with exactly one blank line
  • Wrap at 72 characters
  • Explain why the change was made, not what (the diff shows what)
  • Issue references on their own line at the end

Issue reference formats:

  • Closes #N — closes the issue when the commit lands on main (via PR merge)
  • Refs #N — references without closing
  • Part of #N — partial progress on a larger issue

5. Breaking Changes

Inline ! suffix

For a breaking change in the first line:

feat(agents)!: rename executive-researcher to research-executive

BREAKING CHANGE footer

For breaking changes with a description:

refactor(scripts): consolidate fetch scripts into single entry point

BREAKING CHANGE: fetch_source.py and fetch_all_sources.py now require
--manifest flag; direct URL argument is removed. Update any scripts
or CI steps that call these with bare URLs.

Both methods are valid. Use ! for simple renames/removals; use the footer when a migration note is needed.


6. Examples Representative of This Repo

# New agent added to the fleet
feat(agents): add executive-docs agent for documentation governance

# Bug fix in a script
fix(scripts): correct branch slug calculation for paths with multiple slashes

# Research synthesis doc added
docs(research): add agent-skills-integration synthesis — status: Final

# ADR committed
docs(decisions): add ADR-006 agent skills adoption

# CI gate added
ci: run validate_skill_files.py on PRs touching .github/skills/

# Workplan created at session start
docs(plans): add 2026-03-07-agent-skills-implementation workplan

# Pre-compact safety commit (no scope needed)
chore: pre-compact checkpoint — session state saved to scratchpad

# Dependency update
chore(deps): bump uv.lock after adding mkdocs-material

# Test coverage for a new script
test(scripts): add tests for scaffold_workplan.py happy path and error exits

# Docs-only correction (no functional change)
docs(guides): fix broken link to session-synthesis source stub

7. What NOT to Do

Anti-patternWhy it failsCorrect alternative
update docsVague — what was updated? No type, no scopedocs(guides): clarify programmatic-first decision table
WIP or wip: stuffNot a valid type; not revertable safelyCommit the specific logical unit; use feature branches
feat: update scripts and docs and agentsMultiple unrelated changes in one commitThree separate commits, each with its own scope
Fix #42No type, no scope, no descriptionfix(agents): correct tool restriction for executive-docs (Closes #42)
docs(guides): Added new section.Past tense + trailing perioddocs(guides): add new section
chore: checkpointToo vague for a non-checkpoint session commitUse for pre-compact checkpoints only; otherwise be specific
feat(everything): massive refactorScope "everything" is not a real scopeBreak into per-scope commits
Skipping scope entirely when scope is clearMakes history unfilteredAlways include scope when the change is clearly localized

8. Commit Cadence

Per CONTRIBUTING.md § Commit Discipline: commit frequently as you complete each logical unit of work — not one giant commit at the end of a session.

Unit of workCommit timing
Docs changeCommit immediately after the file is saved
Script changeCommit immediately; tests committed in the same or next commit
Agent file changeCommit immediately; also update README.md catalog in same commit
Workplan createdCommit before Phase 1 executes
Pre-compactCommit all in-flight changes before running /compact
Session endCommit the Session Summary scratchpad content (if extracted to a doc)

This repo uses rebase and merge only — squash merge is disabled. Every commit message lands on main individually, so every commit message must be valid and meaningful standing alone.


9. Governing Constraint

This skill is governed by AGENTS.md § Commit Discipline and CONTRIBUTING.md § Commit Discipline. The Conventional Commits specification is at conventionalcommits.org.

The encoding inheritance chain is:

MANIFESTO.md → AGENTS.md → agent files → this skill → session behaviour.

A commit message is not decoration — it is the durable record of a logical change. Low-quality messages degrade the endogenic substrate: future sessions cannot reconstruct intent from history, and CI cannot identify regressions by type. Write commit messages as if a future agent will rely on them to understand the codebase.

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.