home / skills / fcakyon / claude-codex-settings / commit-workflow

commit-workflow skill

safe

/plugins/github-dev/skills/commit-workflow

This skill automates commit creation by analyzing staged changes and generating standardized messages with context-rich bullet points.

npx playbooks add skill fcakyon/claude-codex-settings --skill commit-workflow

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

1.8 KB

---
name: commit-workflow
description: This skill should be used when user asks to "commit these changes", "write commit message", "stage and commit", "create a commit", "commit staged files", or runs /commit-staged or /commit-creator commands.
---

# Commit Workflow

Complete workflow for creating commits following project standards.

## Process

1. **Use commit-creator agent**
   - Run `/commit-staged [context]` for automated commit handling
   - Or follow manual steps below

2. **Analyze staged files only**
   - Check all staged files: `git diff --cached --name-only`
   - Read diffs: `git diff --cached`
   - Completely ignore unstaged changes

3. **Commit message format**
   - First line: `{task-type}: brief description of the big picture change`
   - Task types: `feat`, `fix`, `refactor`, `docs`, `style`, `test`, `build`
   - Focus on 'why' and 'what', not implementation details
   - For complex changes, add bullet points after blank line

4. **Message examples**
   - `feat: implement user authentication system`
   - `fix: resolve memory leak in data processing pipeline`
   - `refactor: restructure API handlers to align with project architecture`

5. **Documentation update**
   - Check README.md for:
     - New features that should be documented
     - Outdated descriptions no longer matching implementation
     - Missing setup instructions for new dependencies
   - Update as needed based on staged changes

6. **Execution**
   - Commit uses HEREDOC syntax for proper formatting
   - Verify commit message has correct format
   - Don't add test plans to commit messages

## Best Practices

- Analyze staged files before writing message
- Keep first line concise (50 chars recommended)
- Use active voice in message
- Reference related code if helpful
- One logical change per commit
- Ensure README reflects implementation

Overview

This skill automates and enforces a consistent commit workflow for Python projects. It creates clear, standards-compliant commit messages, inspects only staged changes, and helps ensure documentation is updated when code changes require it.

How this skill works

The skill inspects the git index (staged files) using git diff --cached and reads the staged diffs to determine the scope of changes. It generates a concise commit message following a structured format and can run as /commit-staged or via the commit-creator agent to perform the commit using HEREDOC formatting. Unstaged changes are ignored to avoid accidental inclusion.

When to use it

When you ask to commit staged changes (e.g., “commit these changes” or “commit staged files”).
When you want an automated, standardized commit message (e.g., “write commit message”).
When running the /commit-staged or /commit-creator commands.
Before pushing code to ensure one logical change per commit and updated docs.
When you need consistent task-type prefixes like feat, fix, refactor.

Best practices

Analyze staged files only; run git diff --cached --name-only and git diff --cached first.
Keep the first commit line concise (around 50 characters) and use active voice.
Start the first line with a task-type: feat, fix, refactor, docs, style, test, or build.
Focus commit text on why and what changed, not implementation details; add bullets for complex changes.
Commit only one logical change per commit and reference related code or issue IDs if helpful.
Check README.md and other docs for updates required by the staged changes.

Example use cases

Developer stages several files for an API refactor and runs /commit-staged to produce: “refactor: restructure API handlers to align with project architecture.”
Fix a memory issue, stage the fix, and use the skill to create: “fix: resolve memory leak in data processing pipeline.”
Add authentication feature and generate: “feat: implement user authentication system” plus bullets describing migration steps.
Run the agent to verify that documentation (README.md) needs updates after adding new dependencies and include that in the commit workflow.
Use the skill in CI hooks to enforce commit message format before merge.

FAQ

Will this include unstaged changes in the commit?

No. The skill inspects and commits only staged changes (git diff --cached). Unstaged changes are ignored.

What commit message format does it enforce?

A short first line prefixed with a task-type (feat, fix, refactor, docs, style, test, build), focusing on why and what. Complex changes may include bullet points after a blank line.