commit-changes
Create clear, informative, and well-structured Git commit messages following best practices and conventional commit standards.
安装与使用
请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。
查看来源 ↗使用指南技能说明
Commit Changes
Instructions
-
Analyze Changes: Run
git diff --staged,git diff, andgit status -
Stage All: Use
git add -Aif needed - Understand Context: What changed, why, type, scope, patterns
- Check Branch: If on main/master, create descriptive branch first
- Generate Message: Subject ≤72 chars, imperative, conventional type
-
Execute:
git commit -m "<message>"
Commit Message Format
<type>(<scope>): <subject>
<body>
Types
| Type | Use Case |
|---|---|
feat |
New feature |
fix |
Bug fix |
docs |
Documentation only |
style |
Formatting, no code change |
refactor |
Code restructuring |
test |
Adding/fixing tests |
chore |
Build, config, dependencies |
Rules
- Imperative mood ("Add feature" not "Added feature")
- No trailing period
- Subject ≤72 characters
- Body explains what/why, not how
- No co-author credits or "Generated with..." tags
Quality Standards
- Meaningful to someone reading git log months later
- Avoid generic: "fix bug", "update code"
- Group related changes conceptually
- Flag if changes too diverse for single message
Edge Cases
| Situation | Action |
|---|---|
| No changes | Inform user nothing to commit |
| Incomplete changes | Flag observation to user |
| On main/master | Create feature branch first |
| Too diverse | Note to user, suggest splitting |
Examples
Example 1: Feature Commit
feat(auth): add JWT token refresh mechanism
- Implement automatic token refresh before expiration
- Add refresh token storage in secure cookie
- Include retry logic for failed refresh attempts
Example 2: Bug Fix Commit
fix(api): prevent null pointer on empty response
Handle case where API returns empty body instead of
throwing unhandled exception in response parser.
Example 3: Refactor Commit
refactor(streamer): extract common mock to shared helper
- Move mockGRPCStreamClient to mock_query.go
- Consolidate 4 duplicate mock implementations
- Reduce test file coupling
Example 4: Multi-scope Commit
test(streamer): consolidate redundant tests
- Remove TestRemoteStream_Success (duplicate of Recv_EventDelivery)
- Merge Close_Idempotent into TestRemoteStream_Close
- Delete tests with no real assertions
使用示例
查看来源仓库中的使用示例与配置说明。
查看来源 ↗来源历史
- 收录时间
- 2026-01-20
- 索引更新时间
- 2026-01-26
- Branch
- main
收录与同步日期属于本站记录。源码修改历史请查看来源仓库。
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!