CONTRIBUTING 贡献指南是什么
CONTRIBUTING.md 是仓库的贡献说明书：环境搭建、分支命名、提交规范、测试要求、评审与发布节奏、安全问题报告渠道。GitHub 在新建 Issue/PR 时会提示查看它，是新贡献者进入项目的「第一份文档」，也是维护者的大规模减负工具；写得越具体，维护者被重复询问的次数越少；它既是文档，也是协作契约。
基本信息
| 位置 | 仓库根、.github/ 或 docs/（平台按序识别） |
|---|---|
| 内容要点 | 环境搭建、提交规范、PR 模板说明、评审时限、发布流程 |
| 配套文件 | CODE_OF_CONDUCT.md、SECURITY.md、Issue/PR 模板 |
| 原则 | 命令必须可执行、路径必须与仓库实况一致，宁简勿长 |
| 维护 | 流程变更时同步更新，评审中发现偏差顺手勘误 |
典型使用场景
- 开源项目：外部贡献者自助上手，减少重复答疑。
- 团队内部：新人入职第一个迭代的参考资料。
- 外包与合作方：书面约定提交与评审规则。
- 合规要求：说明许可证与贡献者签署要求（如 DCO）。
- 维护者减负：把高频问答固化进文档一次讲清，重复问题直接引用。
- 如何认领 Issue 与求助渠道（聊天群/讨论区）。
最小清单
最小清单
- 本地环境与依赖安装
- 分支命名与提交信息规范（引用规范文档）
- 运行测试与格式化的命令
- PR 描述要求与评审节奏
- 安全问题的私下报告渠道常见配套文件
| 文件 | 用途 | 位置 |
|---|---|---|
| CONTRIBUTING.md | 贡献流程说明 | 根目录或 .github/ |
| SECURITY.md | 漏洞报告渠道 | 同上 |
| CODE_OF_CONDUCT.md | 行为准则 | 同上 |
| Issue/PR 模板 | 规范提交内容与必填项 | .github/ 下 |
贡献指南越具体越省沟通成本：把「怎么跑测试」「哪里提问」写清楚；上线后用一名新人实测指南能否跑通，把卡点回填进文档，形成正循环。