| 位置 | 仓库根、根下 .github/ 或 docs/(GitHub 会识别这些路径) |
|---|---|
| 内容要点 | 环境搭建、提交规范、PR 模板说明、评审时限、发布流程 |
| 配套 | CODE_OF_CONDUCT.md、SECURITY.md、Issue 模板 |
最小清单
最小清单
- 本地环境与依赖安装
- 分支命名与提交信息规范(引用规范文档)
- 运行测试与格式化的命令
- PR 描述要求与评审节奏
- 安全问题的私下报告渠道贡献指南越具体越省沟通成本:把「怎么跑测试」「哪里提问」写清楚,能减少大量重复问答。
在仓库放 CONTRIBUTING.md 说明提交流程:分支命名、提交规范、测试要求、评审与发布节奏;GitHub 会在新建 Issue/PR 时提示查看它。
| 位置 | 仓库根、根下 .github/ 或 docs/(GitHub 会识别这些路径) |
|---|---|
| 内容要点 | 环境搭建、提交规范、PR 模板说明、评审时限、发布流程 |
| 配套 | CODE_OF_CONDUCT.md、SECURITY.md、Issue 模板 |
- 本地环境与依赖安装
- 分支命名与提交信息规范(引用规范文档)
- 运行测试与格式化的命令
- PR 描述要求与评审节奏
- 安全问题的私下报告渠道