Engineering
chinese-commit-conventions avatar

chinese-commit-conventions

Standardize commit messages and automate changelogs with Conventional Commits, tailored for Chinese development teams.

Introduction

This skill provides a comprehensive framework for maintaining high-quality, standardized Git commit histories in Chinese-speaking development environments. It bridges the gap between international Conventional Commits standards and local team practices, ensuring that commit messages are not only syntactically correct but also semantically meaningful for project maintenance and automated release management. By standardizing the format to include type, scope, subject, body, and footer, teams can streamline code reviews and simplify the generation of release logs.

  • Implements Conventional Commits 1.0.0 with Chinese language adaptations, supporting types like feat, fix, docs, style, refactor, perf, test, chore, ci, and revert.

  • Provides a robust commit message template that ensures developers communicate the motivation, technical approach, and impact of changes clearly.

  • Integrates seamless toolchain automation including conventional-changelog-cli for automatic documentation, commitlint for message enforcement, and husky for pre-commit quality checks.

  • Supports advanced Git features such as Breaking Change annotation, Issue tracking across multiple platforms like GitHub, Gitee, and Coding, and lint-staged integration for code formatting.

  • Best practices include keeping the commit subject under 50 characters, ensuring the body explains the 'why' and 'how' of a change, and maintaining atomicity by ensuring each commit addresses only one logical task.

  • Compatible with various CI/CD pipelines and Git hosting services widely used in China, such as Gitee, Coding, and local GitLab instances, alongside international platforms.

  • Constraints include maintaining a 72-character line limit for the body text to ensure readability in terminal-based Git logs and strictly avoiding ambiguous, non-descriptive messages like 'fixed a bug' or 'updated code'.

  • Recommended for team leads and DevOps engineers looking to improve project maintainability and automate release cycles through consistent and informative commit history.

Repository Stats

Stars
1,870
Forks
203
Open Issues
1
Language
Shell
Default Branch
main
Sync Status
Idle
Last Synced
May 3, 2026, 05:46 AM
View on GitHub