commit-message
Write clear, structured git commit messages following Conventional Commits format. Includes type prefixes, scope, breaking change markers, and body conventions for automated changelog generation.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 4
- Forks
- 1
01 前言 Front Matter
- name
- commit-message
- tags
- [ "git", "commit", "conventional-commits", "changelog" ]
- version
- 1.0.0
- category
- github
- description
- Write clear, structured git commit messages following Conventional Commits format. Includes type prefixes, scope, breaking change markers, and body conventions for automated changelog generation.
- related_skills
- [ "github-pr-workflow", "public-contribution" ]
03 SKILL.md 正文
Commit Message Conventions
Format
<type>(<scope>): <subject>
<body>
<footer>
Type
| Type | When to use |
|---|---|
feat |
A new feature |
fix |
A bug fix |
docs |
Documentation only changes |
style |
Formatting, linting — no code change |
refactor |
Code change that neither fixes nor adds |
perf |
Performance improvement |
test |
Adding or fixing tests |
chore |
Build, deps, tooling — no production code change |
ci |
CI config or script changes |
revert |
Reverting a previous commit |
Scope (optional)
The area of the codebase affected:
cron,docs,api,ui,db,auth,deploy,skill,script- Use lowercase, hyphens for multi-word:
cron-job,fleet-ref
Subject
- Imperative mood: "Add" not "Added" or "Adds"
- No trailing period
- Max 72 characters — this is what appears in
git log --oneline - Lowercase after type/scope:
feat: add loginnotfeat: Add login
Body
- Explain WHAT changed and WHY, not HOW
- Separate from subject with blank line
- Wrap at 72 characters
- Use bullet points for multiple reasons
- Angular convention: body is mandatory for all commits except
docs
Footer
- Breaking changes:
BREAKING CHANGE: <description>or use!after type/scope:feat(api)!: remove deprecated v1 endpoints - Issue references:
Closes #123,Refs #456 - Co-authors:
Co-authored-by: Name <email> - Reviewed-by:
Reviewed-by: Name <email>
SemVer Mapping
| Commit type | Version bump | Example |
|---|---|---|
feat! or BREAKING CHANGE |
MAJOR | feat!: change auth token format |
feat |
MINOR | feat: add user preferences endpoint |
fix |
PATCH | fix: handle empty request body |
perf |
PATCH | perf: cache pagination count query |
| Other types | No bump | docs: update README |
Examples
feat(auth): add OAuth2 login with Google provider
Users can now sign in with their Google account.
Existing email/password auth is unchanged.
Closes #234
fix(api): handle empty request body in POST /users
The endpoint returned 500 when called with an empty body.
Now returns 400 with a descriptive error message.
Refs #345
refactor(cron): extract schedule validation to shared module
The same schedule parsing logic was duplicated across
install-crons.sh and the cron MCP tool. Moved to a shared
validate_schedule() function.
BREAKING CHANGE: schedule validation now rejects whitespace
in cron expressions. Existing schedules verified clean.
docs: add API authentication section to README
Documents how to obtain and use bearer tokens,
including example curl commands for each auth flow.
chore(deps): upgrade pandas to 2.2.0
Pins pandas >=2.2 to avoid the DataFrame.copy() regression
in 2.1.x. All tests pass.
Rules for This Repo
- Always use lowercase type prefixes.
- Prefer
featorfix— saverefactorfor truly structural changes. - Include scope for changes that affect a specific subsystem.
- One logical change per commit — don't combine
feat+fix+docs. - Use
git commit -mfor single-line commits,git commit(editor) for multi-line. - For squashed PR merges: the merge commit message should be a summary
of all commits in the branch, with
Co-authored-byfor contributors.
Verification
# Check subject line length
git log -1 --pretty=%s | wc -c
# Should output ≤ 73 (72 + newline)
# Check for conventional commit format
echo "$(git log -1 --pretty=%s)" | grep -qE '^(feat|fix|docs|style|refactor|perf|test|chore|ci|revert)(\(.+\))?: '
# Exit 0 = valid format
04 同仓库更多 Skills
macbook-linux-maintenance
Legacy MacBook Linux fixes: GPU wedge, reboot hang, thermal.
governance-regression-triage
Triage a host's governance issues: what changed.
enforcement-immutability
Use when enforcement files lose their immutable flag.
steadfaste-fleet-repo-deploy
Use when committing to the steadfaste-fleet repo.
steadfaste-fleet-maintenance
Maintain an installed Steadfaste Fleet instance — update both the upstream Hermes Agent and the fleet repo layer, merge diverged histories, sync skills safely, and troubleshoot common issues. Covers the dual-update workflow (hermes update + fleet-update.sh), encrypted brain data backup, mycortex import, and recovery techniques.
fleet-preflight
DEPRECATED alias — merged into survey-before-action (2026-08-20). Load survey-before-action instead; its "Repo-Specific Pre-Flight" section covers git search, Hermes boundary, and deployment verification.