Back to Details

engram-commit-hygiene

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

When to Use

使用场景

Use this skill when:
  • Creating commits
  • Reviewing commit history in a PR
  • Cleaning up staged changes
在以下场景使用本规范：
  • 创建代码提交
  • 在PR中审核提交历史
  • 清理暂存的变更

Rules

规范规则

  1. Use conventional commit format.
  2. Keep one logical change per commit.
  3. Message should explain why, not only what.
  4. Never include 
    Co-Authored-By
    in this repo.
  5. Never commit generated/temp/local files.
  1. 采用Conventional Commit格式。
  2. 每个提交仅包含一个逻辑变更。
  3. 提交信息应说明原因，而非仅描述内容。
  4. 本仓库中禁止包含
    Co-Authored-By
    信息。
  5. 禁止提交生成的/临时的/本地文件。

Pre-Commit Checklist

提交前检查清单

  • Diff matches commit scope
  • No secrets or credentials
  • No binaries, coverage outputs, or local artifacts
  • Tests relevant to the change passed
  • Commit message is clear and conventional
  • 代码差异与提交范围一致
  • 不包含密钥或凭证
  • 不包含二进制文件、覆盖率输出或本地构建产物
  • 与变更相关的测试已通过
  • 提交信息清晰且符合Conventional格式