复制并调整贡献指南模板
替换占位文字,验证每条命令和每个链接。即使贡献者还不能修改应用代码,也应欢迎文档纠错和问题反馈。
# 参与贡献
## 开始之前
阅读 README,并检查已有 Issue。
较大改动请先讨论方案,再开始实现。
## 本地环境
[所需运行时和已经验证的配置命令]
## 报告问题
提供版本、环境、复现步骤、预期结果和实际结果。
从日志中移除密钥和个人信息。
## 提交 Pull Request
- 说明问题和拟议修改。
- 保持改动聚焦。
- 运行[本项目要求的检查]。
- 更新受影响的文档。
## 审查
[由谁审查、如何回复,以及实际可投入的时间]
## 其他参与方式
[文档、示例、翻译或可复现的问题反馈]让贡献指南容易找到
GitHub 能识别仓库根目录、docs 或 .github 目录中的贡献指南。也可以从 README 链接它,让阅读项目介绍的人直接找到参与流程。
从仓库实际的贡献入口检查访问路径。如果存在多份指南,应合并相互矛盾的说明。不要让贡献者在 README 看到一条配置命令,进入贡献指南却遇到另一条不受支持的命令。
设计一个容易开始的贡献任务
选择结果清晰的小任务,例如修正一个受支持运行时的示例。说明如何复现问题、需要改变什么行为,以及怎样检查完成。如果任务依赖没有记录的内部知识,就不要把它标成适合新手。
如实说明能够投入的审查时间。无法承诺回复时限时,可以解释贡献者如何查看状态。清晰的边界有助于减少白做的工作,比承诺合并所有贡献更有用。
常见问题
CONTRIBUTING.md 可以替代 README.md 吗?
不能。README 说明项目及其使用方法;贡献指南说明如何提出修改和验证改动。
可以直接复制别的项目的测试命令吗?
只有这些命令也确实适用于本项目时才可以。请用实际验证过的命令替换占位内容。
有贡献指南就能保证增加贡献者吗?
不能。它能减少有意参与者的不确定性,但项目是否有用、任务是否清晰,以及维护者是否跟进仍然重要。