README 的贡献指南(Contributing)怎么写

更新于 2026-08-30 · AI README 生成器

没有贡献指南,潜在贡献者不知道从哪下手,也容易提交不符合规范的 PR。

Contributing 要覆盖

  1. 本地起环境:clone + 安装依赖 + 跑测试的完整步骤。
  2. 分支与提 PR 规范:从哪条分支切、commit 风格、是否关联 Issue。
  3. 代码规范:lint / format / 测试命令。
  4. 行为准则:链接到 CoC,或写一句「友好、就事论事」。

轻量写法

## 贡献
1. Fork 并 clone
2. `npm install && npm test`
3. 提 PR,描述解决了什么问题

大项目建议单独建 CONTRIBUTING.md 并在 README 里链接;小项目直接写在 README 即可。工具生成的 README 已含基础 Contributing 段落。

立即使用 AI README 生成器 →