贡献指南

April 8, 2026 · View on GitHub

目录与编号

  • 十六个主题域practices/01-...practices/16-...(见 practices/README.md)。
  • 每个域README.md(总述)+ 6 个原子文件 01-*.md06-*.md
  • 原子 IDA{域号两位}-{序号},例如域 03 第 2 条为 A03-02(写在原子文件首行注释或标题)。

原子文件格式(建议)

# Axx-yy · 短标题

**检查**:一句可勾选的自检问句。  
**反模式**:常见错误写法或行为。  
**提示**:给 Agent 的一句引导语(可选)。
  • 单文件 不宜过长;若需展开,链到 docs/examples/

PR 要求

  • 中文或中英并列均可;与现有文件风格一致。
  • 修改原子时更新对应域 README.md 中的列表(若有)。
  • 不引入与 OKR 无关的「操控类」内容。

重新生成(可选)

若仓库含 scripts/generate_practices.py,在根目录执行:

python3 scripts/generate_practices.py

仅维护者在大规模调整编号时使用;日常 PR 可直接编辑 Markdown。