commit-best-practices

Enforce git commit best practices and workflow guidance

8 stars

Best use case

commit-best-practices is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Enforce git commit best practices and workflow guidance

Teams using commit-best-practices should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/commit-best-practices/SKILL.md --create-dirs "https://raw.githubusercontent.com/dhofheinz/open-plugins/main/plugins/git-commit-assistant/commands/commit-best-practices/skill.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/commit-best-practices/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How commit-best-practices Compares

Feature / Agentcommit-best-practicesStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Enforce git commit best practices and workflow guidance

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# Commit Best Practices Skill Router

You are orchestrating commit best practices validation and workflow guidance operations.

## Parse Request

Examine `$ARGUMENTS` to determine the operation and parameters:

**Format**: `<operation> [parameters]`

## Available Operations

1. **check-pre-commit** - Validate repository state before committing
   - Runs tests, lint checks, detects debug code
   - Validates no TODOs, no merge markers
   - Format: `check-pre-commit [quick:true|false]`

2. **review-commit** - Review most recent commit quality
   - Analyzes commit message and changes
   - Checks atomicity and completeness
   - Format: `review-commit [commit:HEAD|<sha>]`

3. **amend-guidance** - Guide safe commit amending
   - Checks if safe to amend (not pushed, same author)
   - Provides amend instructions
   - Format: `amend-guidance [force:true|false]`

4. **revert-guidance** - Help with commit reverts
   - Generates proper revert commit message
   - Provides revert instructions
   - Format: `revert-guidance commit:<sha>`

5. **workflow-tips** - Complete git workflow guidance
   - Best practices overview
   - Branch management tips
   - Format: `workflow-tips [focus:commit|branch|merge]`

## Routing Logic

```
Parse first word from $ARGUMENTS:
  "check-pre-commit" → Read commands/commit-best-practices/check-pre-commit.md
  "review-commit"    → Read commands/commit-best-practices/review-commit.md
  "amend-guidance"   → Read commands/commit-best-practices/amend-guidance.md
  "revert-guidance"  → Read commands/commit-best-practices/revert-guidance.md
  "workflow-tips"    → Read commands/commit-best-practices/workflow-tips.md
  (unknown)          → Show error and list available operations
```

## Base Directory

**Location**: `.claude/commands/commit-best-practices/`

## Error Handling

If operation is not recognized:
```
ERROR: Unknown operation: <operation>

Available operations:
  - check-pre-commit [quick:true|false]
  - review-commit [commit:HEAD|<sha>]
  - amend-guidance [force:true|false]
  - revert-guidance commit:<sha>
  - workflow-tips [focus:commit|branch|merge]

Example: /commit-best-practices check-pre-commit quick:true
```

## Request Context

**User Request**: `$ARGUMENTS`

Now route to the appropriate operation file and execute its instructions with the provided parameters.

Related Skills

best-practices

8
from dhofheinz/open-plugins

Enforce OpenPlugins and Claude Code best practices for naming, versioning, and standards compliance

commit-error-handling

8
from dhofheinz/open-plugins

Handle git errors and edge cases gracefully

commit-analysis

8
from dhofheinz/open-plugins

Analyze git changes to understand nature, scope, and commit type for intelligent message generation

atomic-commit

8
from dhofheinz/open-plugins

Guide splitting large commits into atomic, focused commits

specification-writing

8
from dhofheinz/open-plugins

Core reference for EARS requirement patterns, Given/When/Then acceptance criteria, RFC 2119 language, requirement ID conventions, and specification quality checklists. Background knowledge for the spec-writer agent. Preloaded by spec-writer via the skills frontmatter field; not user-invocable.

refine

8
from dhofheinz/open-plugins

Unified specification refinement plugin. Single entry point for all spec operations: greenfield architecture pipelines (principles → design → stack → spec → plan), feature spec creation in existing systems, iterative convergence loops, quality reviews, drift detection, finalization, ticket decomposition, traceable updates, and lifecycle archival. Detects pipeline state from existing artifact frontmatter and routes intelligently. Use whenever you need to create, refine, validate, or evolve a technical specification.

validation-orchestrator

8
from dhofheinz/open-plugins

Intelligent validation orchestrator with auto-detection and progressive validation workflows

security-scan

8
from dhofheinz/open-plugins

Comprehensive security scanning for secrets, vulnerabilities, and unsafe practices

schema-validation

8
from dhofheinz/open-plugins

Validate JSON schemas, required fields, and format compliance for marketplaces and plugins

quality-analysis

8
from dhofheinz/open-plugins

Deep quality analysis with scoring, recommendations, and actionable reports

documentation-validation

8
from dhofheinz/open-plugins

Validate documentation completeness, format, and quality for plugins and marketplaces

message-generation

8
from dhofheinz/open-plugins

Generate conventional commit messages following best practices