代码贡献指南
本指南将概述完整的贡献流程:从提交问题、创建 PR、审核到合并 PR。
如果您想为本项目贡献代码,请遵循以下步骤:
解决现有问题
Section titled “解决现有问题”浏览我们的现有问题^,寻找您感兴趣的任务。您可以使用标签
作为筛选器缩小搜索范围。如果找到要处理的问题,欢迎提交包含修复方案的 PR。
-
分叉仓库
-
使用 GitHub Desktop:
- GitHub Desktop 入门指南^将引导您设置 Desktop
- 设置完成后,您可以用它来分叉仓库^!
-
使用命令行:
- 分叉仓库^,这样您可以在准备好合并更改前不影响原始项目
-
-
安装或更新 Node.js 和 pnpm,版本需符合
.prototools
^ 中的指定要求 -
创建工作分支并开始您的更改!
-
为您的更改编写测试(如果适用)
-
更新文档(如果需要)
当您对更改满意后,提交这些更改。
拉取请求 (PR)
Section titled “拉取请求 (PR)”完成更改后,创建拉取请求(也称为 PR)。
- 填写”准备审核”模板,以便我们审核您的 PR。此模板帮助审核者理解您的更改以及 PR 的目的
- 如果您正在解决问题,别忘了将 PR 链接到问题^
- 启用允许维护者编辑^复选框,以便可以更新分支进行合并
提交 PR 后,文档团队成员将审核您的提案。我们可能会提出问题或要求提供额外信息。
- 在 PR 合并前,我们可能会要求进行更改,可能使用建议的更改^或 PR 评论。您可以直接通过 UI 应用建议的更改。您可以在自己的分叉中进行任何其他更改,然后将它们提交到您的分支
- 当您更新 PR 并应用更改时,将每个对话标记为已解决^
- 如果遇到任何合并问题,请查看此 Git 教程^以帮助您解决合并冲突和其他问题
您的 PR 已合并!
Section titled “您的 PR 已合并!”恭喜!StudioCMS 团队感谢您。您的贡献将成为下一个版本的一部分。
现在您已成为 StudioCMS 社区的一员,可以帮助我们审核其他 PR、回答问题并帮助其他贡献者。如果尚未加入,请参加我们的 Discord^,与其他贡献者和 StudioCMS 团队联系。
哦,您还会在贡献者列表中看到自己!🎉