1.8 KiB
1.8 KiB
name, description
| name | description |
|---|---|
| commit-workflow | 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-manager commands. |
Commit Workflow
Complete workflow for creating commits following project standards.
Process
-
Use commit-manager agent
- Run
/commit-staged [context]for automated commit handling - Or follow manual steps below
- Run
-
Analyze staged files only
- Check all staged files:
git diff --cached --name-only - Read diffs:
git diff --cached - Completely ignore unstaged changes
- Check all staged files:
-
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
- First line:
-
Message examples
feat: implement user authentication systemfix: resolve memory leak in data processing pipelinerefactor: restructure API handlers to align with project architecture
-
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
- Check README.md for:
-
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