Дом
commit-standards
AsiaOstrich/universal-dev-skills
Оформляйте сообщения о фиксации в соответствии со стандартом Conventional Commits. Используйте при: написании сообщений о фиксации, выполнении команды `git commit`, просмотре истории фиксаций. Ключевые слова: commit, git, message, conventional, 提交, 訊息, feat, fix, refactor.
...Расширить всеО навыке «commit-standards»
Навык «commit-standards» обеспечивает единообразное форматирование сообщений о фиксации, следуя стандарту Conventional Commits. Это гарантирует, что сообщения о фиксации будут ясными, лаконичными и информативными. Он решает проблему несогласованных или неясных сообщений о фиксации, предлагая структурированный подход к их написанию, что способствует формированию более упорядоченной и понятной истории фиксаций. Данный стандарт особенно полезен при совместной работе над проектами по разработке программного обеспечения, где четкое управление версиями и документирование изменений имеют решающее значение как для команд, так и для автоматизированных систем.
Этот навык разработан для обеспечения простого и интуитивно понятного способа форматирования сообщений о фиксации. Он использует набор предопределенных типов фиксаций, таких как «feat», «fix», «refactor» и других, для эффективной классификации изменений. Пользователи могут следовать строгому формату, включающему тему, основной текст и нижний колонтитул, с конкретными правилами относительно длины темы, использования заглавных букв и пунктуации. Скилл также поддерживает многоязычные форматы сообщений о фиксации, включая английский, традиционный китайский и двуязычные варианты, чтобы удовлетворить потребности различных сред разработки.
Этот навык идеально подходит для разработчиков, команд и участников проектов с открытым исходным кодом, которые стремятся поддерживать единообразный и профессиональный подход к сообщениям о фиксации. Он особенно полезен для рецензентов кода, менеджеров систем контроля версий и всех заинтересованных сторон, которые полагаются на историю фиксаций для понимания изменений в коде. Система настройки этого навыка позволяет гибко настраивать его в соответствии с предпочтениями проекта, благодаря чему он легко адаптируется к различным рабочим процессам и потребностям команды.
Часто задаваемые вопросы
Как настроить язык сообщений о фиксации?
Вы можете настроить язык сообщений о фиксации в файле «CONTRIBUTING.md» вашего проекта. Если настройки не найдены, по умолчанию будет использоваться английский язык. Доступны следующие варианты: английский, традиционный китайский и двуязычный.
Что произойдет, если моё сообщение о фиксации не соответствует стандарту?
Скилл не будет автоматически выявлять ошибки, но рекомендует следовать лучшим практикам для обеспечения единообразия и ясности. Ваша команда сама должна следить за тем, чтобы сообщения соответствовали установленному формату.
Можно ли использовать этот инструмент для проектов, не связанных с разработкой программного обеспечения?
Да, хотя он в первую очередь предназначен для программных проектов, этот скилл может быть полезен для любого проекта, требующего чёткого управления версиями и документирования изменений.
Поддерживает ли этот с킬 сообщения о коммитах на нескольких языках?
Да, этот инструмент поддерживает сообщения о фиксации на английском, традиционном китайском и в двуязычном формате. Вы можете выбрать предпочтительную языковую конфигурацию в файле «CONTRIBUTING.md».
Какие типы коммитов поддерживает этот навык?
Навык поддерживает различные типы коммитов, включая «feat», «fix», «refactor», «docs», «style», «test», «perf», «build», «ci», «chore», «revert» и «security».
Commit Message Standards
This skill ensures consistent, meaningful commit messages following conventional commits.
Quick Reference
Basic Format
<type>(<scope>): <subject><body><footer>Commit Types
| English | 中文 | When to Use |
|---|---|---|
feat | 新增 | New feature |
fix | 修正 | Bug fix |
refactor | 重構 | Code refactoring (no functional change) |
docs | 文件 | Documentation only |
style | 樣式 | Formatting (no code logic change) |
test | 測試 | Adding or updating tests |
perf | 效能 | Performance improvement |
build | 建置 | Build system or dependencies |
ci | 整合 | CI/CD pipeline changes |
chore | 維護 | Maintenance tasks |
revert | 回退 | Revert previous commit |
security | 安全 | Security vulnerability fix |
Subject Line Rules
- Length: ≤72 characters (50 ideal)
- Tense: Imperative mood ("Add feature" not "Added feature")
- Capitalization: First letter capitalized
- No period: Don't end with a period
Detailed Guidelines
For complete standards, see:
- Conventional Commits Guide
- Language Options
Examples
✅ Good Examples (English)
feat(auth): Add OAuth2 Google login supportfix(api): Resolve memory leak in user session cacherefactor(database): Extract query builder to separate classdocs(readme): Update installation instructions for Node 20✅ Good Examples (中文)
新增(認證): 實作 OAuth2 Google 登入支援修正(API): 解決使用者 session 快取記憶體洩漏重構(資料庫): 提取查詢建構器為獨立類別✅ Good Example (Bilingual)
feat(auth): Add OAuth2 Google login support. 新增 OAuth2 Google 登入支援。Implement Google OAuth2 authentication flow for user login.實作 Google OAuth2 認證流程供使用者登入。Closes #123❌ Bad Examples
fixed bug # Too vague, no scopefeat(auth): added google login # Past tenseUpdate stuff. # Period, vagueWIP # Not descriptiveBody Guidelines
Use the body to explain WHY the change was made:
fix(api): Resolve race condition in concurrent user updatesWhy this occurred:- Two simultaneous PUT requests could overwrite each other- No optimistic locking implementedWhat this fix does:- Add version field to User model- Return 409 Conflict if version mismatchFixes #789Breaking Changes
Always document breaking changes in footer:
feat(api): Change user endpoint response formatBREAKING CHANGE: User API response format changedMigration guide:1. Update API clients to remove .data wrapper2. Use created_at instead of createdAtIssue References
Closes #123 # Automatically closes issueFixes #456 # Automatically closes issueRefs #789 # Links without closingConfiguration Detection
This skill supports project-specific language configuration.
Detection Order
- Check
CONTRIBUTING.mdfor "Commit Message Language" section - If found, use the specified option (English / Traditional Chinese / Bilingual)
- If not found, default to English for maximum tool compatibility
First-Time Setup
If no configuration found and context is unclear:
- Ask the user: "This project hasn't configured commit message language preference. Which option would you like to use? (English / 中文 / Bilingual)"
- After user selection, suggest documenting in
CONTRIBUTING.md:
## Commit Message LanguageThis project uses **[chosen option]** commit types.<!-- Options: English | Traditional Chinese | Bilingual -->
Configuration Example
In project's CONTRIBUTING.md:
## Commit Message LanguageThis project uses **English** commit types.### Allowed Typesfeat, fix, refactor, docs, style, test, perf, build, ci, chore, revert, security
License: CC BY 4.0 | Source: universal-dev-standards
Все файлы
3 файловУстановить commit-standards
Скачайте файлы навыков и распакуйте их в каталог .claude/skills/.
Скачать ZIPКлонируйте репозиторий и скопируйте файлы навыка в свой проект.
git clone https://github.com/AsiaOstrich/universal-dev-skills/blob/main/skills/commit-standards/SKILL.md # Copy SKILL.md to your .claude/skills/ directory
Копировать
