agentleFS
Sign inStart free
theyoungastronautstheyoungastronauts/polaris/skills/commit-conventions/SKILL.md

commit-conventions

Skill4 starsChanged 3 months agoMITView on GitHub

Conventional-commit message format and pull-request description conventions. Apply when writing a git commit message or PR description.

7 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

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

  • 0

    Common

    Most of the 6 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

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

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

    When the project uses separate git repos per stack (e.g., server/ and web/ are each their own repo):

    line 56
  2. Very specific:

    Check which repo you're in: before committing: git -C <dir> rev-parse --show-toplevel

    line 58

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

Skill: Commit Conventions

Format

type(scope): concise description

[optional body — explain WHY, not WHAT]

[optional footer — references, breaking changes]

Types

  • feat: New feature
  • fix: Bug fix
  • refactor: Code change that neither fixes a bug nor adds a feature
  • test: Adding or updating tests
  • docs: Documentation only
  • chore: Build, CI, tooling changes
  • style: Formatting, no code change

Rules

  • Subject line: imperative mood, lowercase, no period, max 72 chars
  • Body: wrap at 72 chars, explain motivation and context
  • Reference the plan/phase when applicable: Part of plan: [feature-name] Phase 2
  • One logical change per commit — don't mix refactoring with features

PR Description

## What
Brief description of the change.

## Why
Context and motivation.

## Phase
[Plan name] — Phase N: [Phase title]

## Changes
- Key change 1
- Key change 2

## Testing
How this was tested.

## Integration Notes
Any cross-repo impacts or integration summary updates.

Multi-Repo Projects

When the project uses separate git repos per stack (e.g., server/ and web/ are each their own repo):

  • Check which repo you're in before committing: git -C <dir> rev-parse --show-toplevel
  • Commit from within the stack directory: git -C server add . && git -C server commit -m "..."
  • Never combine changes across repos in a single commit — they are independent histories
  • If a phase touched multiple repos (it shouldn't), make separate commits in each

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.

Check your setup, free