Skip to content

Isurwars/Correlation / .agents/skills/commit

Generate and validate Conventional Commits from git staged diffs. Use when crafting commits, preparing pull requests, or validating commit message format.

Conventional Commit Standards

This skill generates and validates commit messages following Conventional Commits for the Correlation project.

1. Commit Message Generation Protocol

When asked to generate a commit message:

  1. Inspect Staged Changes: Run git diff --cached --stat to identify modified files.
  2. Classify Change Type: Map the dominant change category to a Conventional Commits type:
TypeTrigger Pattern
featNew functions, classes, UI components, or CLI options
fixBug corrections, error handling fixes, crash prevention
refactorCode restructuring without behavior change
perfAlgorithm optimization, cache alignment, SIMD changes
testNew or modified test cases
docsDoxygen comments, README, documentation changes
buildCMakeLists.txt, dependencies, compiler flag changes
ciCI/CD GitHub workflows and deployment pipelines
choreFormatting, linting, agent hooks, dependency bumps
  1. Select Scope: Match modified file paths to project scopes:
ScopePath Pattern
rdf, pdf, sq, pad, rings, msd, vacf, vdos, lefsrc/calculators/<name>*, include/calculators/<name>*
analysis, calculators, math, physics, mlipsrc/analysis/**, src/math/**, src/physics/**, src/mlip/**
readers, writers, iosrc/readers/**, src/writers/**, include/readers/**, include/writers/**
ui, slint, plottersui/**, src/app/**, src/plotters/**
bindingssrc/bindings/**, python/**
clisrc/cli/**, include/cli/**
core, utilssrc/core/**, src/utils/**, include/core/**
cmake**/CMakeLists.txt, cmake/**, CMakePresets.json
teststests/**
docsdocs/**, *.md
  1. Format Output:
<type>(<scope>): <imperative description, max 72 chars>

<body: explain WHY, not WHAT — 1-3 sentences max>

2. Validation Rules

  • Subject line must be ≤ 72 characters.
  • Subject must use imperative mood ("add", "fix", "remove" — not "added", "fixes", "removed").
  • Body must explain rationale, not repeat the diff.
  • Breaking changes must include BREAKING CHANGE: footer or ! suffix: feat(core)!: description.

3. Anti-Patterns

  • ❌ "Updated files" — no description of what changed.
  • ❌ "Fixed bug" — no scope or specificity.
  • ❌ "feat: Added new feature to do the thing" — past tense, vague.
  • ✅ "feat(rdf): add Lorch modification function for g(r) smoothing" — correct.
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 318kUpdated Claude CodeCodexUnverifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 318kUpdated Claude CodeCodexUnverifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 318kUpdated Claude CodeCodexUnverifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 318kUpdated Claude CodeCodexUnverifiedInstall