首页/开发/Git 与协作速查/CONTRIBUTING 贡献指南
协作与代码评审75 条

CONTRIBUTING 贡献指南

在仓库放 CONTRIBUTING.md 说明提交流程:分支命名、提交规范、测试要求、评审与发布节奏;GitHub 会在新建 Issue/PR 时提示查看它。

Git 与协作速查开发更新于 2026-10-12
位置仓库根、根下 .github/ 或 docs/(GitHub 会识别这些路径)
内容要点环境搭建、提交规范、PR 模板说明、评审时限、发布流程
配套CODE_OF_CONDUCT.md、SECURITY.md、Issue 模板

最小清单

最小清单
- 本地环境与依赖安装
- 分支命名与提交信息规范(引用规范文档)
- 运行测试与格式化的命令
- PR 描述要求与评审节奏
- 安全问题的私下报告渠道
贡献指南越具体越省沟通成本:把「怎么跑测试」「哪里提问」写清楚,能减少大量重复问答。

易错点

  • 指南与实际流程脱节(命令跑不通)会劝退贡献者,定期更新并验证命令
  • 安全报告渠道写错会让研究者把漏洞发到公开 Issue,务必核对邮箱与页面

数据来源与参考

  • GitHub Docs:Setting guidelines for repository contributors
  • GitLab Docs:Contribution guidelines
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌