chinese-commit-conventions

Featured

中文 Git 提交规范 — 适配国内团队的 commit message 规范和 changelog 自动化

Code & Development 3,943 stars 381 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 93/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 中文 Git 提交规范 ## 1. Conventional Commits 中文适配 基于 Conventional Commits 1.0.0 规范,针对中文团队的实际使用习惯进行适配。 ### 类型(type)定义 | 类型 | 说明 | 示例场景 | | ---------- | ---------------------------- | -------------------------- | | `feat` | 新功能 | 添加用户注册模块 | | `fix` | 修复缺陷 | 修复登录页白屏问题 | | `docs` | 文档变更 | 更新 API 接口文档 | | `style` | 代码格式(不影响逻辑) | 调整缩进、补充分号 | | `refactor` | 重构(非新功能、非修复) | 拆分过长的服务类 | | `perf` | 性能优化 | 优化首页列表查询速度 | | `test` | 测试相关 | 补充用户模块单元测试 | | `chore` | 构建/工具/依赖变更 | 升级 webpack 到 v5 | | `ci` | 持续集成配置 | 修改 GitHub Actions 流程 | | `revert` | 回滚提交 | 回滚 v2.1.0 的登录重构 | ### 原则 - type 保留英文关键字(工具链兼容性好) - scope 和 description 使用中文 - body 使用中文完整描述 ## 2. 中文 commit message 模板 ``` <type>(<scope>): <subject> <body> <footer> ``` ### 完整示例 ``` feat(用户模块): 添加手机号一键登录功能 - 接入运营商一键登录 SDK - 支持移动、联通、电信三网 - 登录失败自动降级到短信验证码 Closes #128 ``` ``` fix(订单): 修复并发下单导致库存超卖的问题 在高并发场景下,原有的库存扣减逻辑存在竞态条件。 改用 Redis 分布式锁 + 数据库乐观锁双重保障。 影响范围:订单服务、库存服务 测试确认:已通过 500 并发压测验证 Closes #256 ``` ## 3. Subject 行规范 ### 格式 ``` <type>(<scope>): <description> ``` ### 规则 - **type**: 必填,从上方类型表中选取 - **scope**: 选填,表示影响范围,使用中文模块名 - 示例:`用户模块`、`订单`、`支付`、`基础组件` - **description**: 必填,中文简述,不超过 50 个字符 - 使用动宾短语:「添加 xxx」「修复 x...

Details

Author
jnMetaCode
Repository
jnMetaCode/superpowers-zh
Created
2 months ago
Last Updated
yesterday
Language
Shell
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

Code & Development Listed

conventional-commits

Writes and reviews Conventional Commits commit messages (v1.0.0) to support semantic versioning and automated changelogs. Use when drafting git commit messages, PR titles, release notes, or when enforcing a conventional commit format (type(scope): subject, BREAKING CHANGE, footers, revert).

56 Updated 5 days ago
knoopx
Code & Development Listed

commit

Summarize current session changes using git status/diff, then propose 3 Conventional Commit messages with scope limited to model|motion|ui. Only run git commands that read state; never commit/push without approval.

23 Updated 2 months ago
Renkunzhao
Code & Development Solid

git-master

Use when committing changes to git or naming branches. Triggers include "commit", "커밋", "git commit", "finalize changes", "save to git", "commit my work", "branch name", "브랜치 이름", "what should I name this branch".

22 Updated today
toongri
AI & Automation Listed

conventions

当遇到不确定的项目规范、查询 Agent 历史错误模式、或需要更新项目知识库时触发。

175 Updated today
WenJunDuan
Code & Development Solid

ai-instruction-standards

创建和维护 AI 指令文件(CLAUDE.md、.cursorrules 等)并采用适当结构。 使用时机:创建 AI 指令文件、区分通用与项目特定规则、配置 AI 工具。 关键字:CLAUDE.md, cursorrules, windsurfrules, clinerules, AI instructions, system prompt, 指令文件, AI 设定.

66 Updated 3 days ago
AsiaOstrich