# 贡献指南（CONTRIBUTING）

本文档说明如何为 Kam 贡献代码、文档与翻译。


## 1. 你可以贡献什么

- **代码贡献**：核心 CLI（Rust）、模板与脚本（Shell）、构建/钩子系统等
- **文档贡献**：README、KamWiki、命令示例与运行手册
- **翻译贡献**：本地化文案与文档修订
- **问题反馈**：Bug、兼容性、使用体验、提案（RFC/DEC）


## 2. 开发与提交流程

1. Fork 本仓库并创建分支：
   ```bash
   git checkout -b feat/<topic>
   ```
2. 进行修改（尽量小步提交，保持变更聚焦）。
3. 提交：
   ```bash
   git commit -m "<type>: <summary>"
   ```
4. Push 并创建 Pull Request，描述：
   - 你解决了什么问题
   - 你做了哪些设计选择
   - 如果涉及行为变更，请提供验证方式/复现步骤


## 3. 文档贡献（README / KamWiki）

- README 应聚焦“新手可跑通”的主路径，把过长的细节放到独立文档/网站。
- `kam.toml` 字段、模板渲染边界和模板验证流程应优先更新：
  - [Kam TOML 规范](docs/kam-toml.md)
  - [模板开发规范](docs/template-development.md)
- 文档必须与当前实现一致：
  - 命令示例应尽量来自真实 `--help` 输出或可复现的工作流
  - 重要术语（kam、kamfw、KamModuleLab、phase）要保持一致

### 构建文档站（KamWiki）

- 目录：`KamWiki/`
- 如需更新文档站内容，请在 PR 中描述如何本地预览与构建。


## 4. 翻译贡献（i18n）

- 相关入口：`src/i18n.rs`
- 原则：保持术语一致，避免同一概念多译。


## 5. AI 使用规范

- 本仓库接受 AI 辅助代码，但必须满足：
  - 可读、可维护
  - PR 描述中说明关键设计与风险
