OhMySkills
团队规范 git-conventional-commits-documentation 更新于 2026-08-24

Git Conventions · 文档规则

Documentation rules for Git Conventions: decision-level content, tested examples and versioned guides.

技术栈
Git Conventions
主题
文档
条目
9 条
版本
v0.2.0

✓ 应当这么做

  • ✓ Document decisions and invariants, not restatements of the code
  • ✓ Keep runnable examples in the docs and test them in CI
  • ✓ Date and version external-facing documents

✕ 常见反模式

  • ✕ Copy-pasted README sections that drift from the code
  • ✕ Docs without an owner
  • ✕ Silently dropping deprecated configuration from the guide

◎ 交付前验证

  • ◎ Pipeline runtime measured; long jobs identified
  • ◎ Required checks are enforced on merges
  • ◎ Rollback job executed once against a real environment

同分类条目

17 篇

同一技术栈的其他条目