Home

本项目 WIKI 用于记录项目维护和管理相关的重要事项。

如何进行此教程的后续更新

1. 目前教程中文版文件所对应的英文版文件存储于 en-comparison 分支；
2. 管理员定期基于 en-comparison 分支新开一个分支，然后把上游最新的英文文件 commit 到新开的分支；
3. 并将 新开的分支 PR 到 en-comparison 分支，我们就可以通过 PR 里的 Files changed 页面清楚地看到有哪些文件的哪些为止有更新；
4. 如果更新量少，管理员只需要通过新开的一个分支提交所有最新英文版文件，根据 Files changed 进行对应的中文版教程的更新；
5. 如果更新量较大，管理员可以基于 en-comparison 分支有序地多开几个分支，每个分支用于 commit 一个或几个章节的最新英文版文件，用于后续的中文版教程更新。更新是以新开的 PR 为任务认领单位，每人每次只能认领一个 分支对应的教程更新；
6. 管理员可以内部商讨，分配任务完成更新。也可以将更新任务通过 issue 进行发布，公开征集志愿者，管理员进行过程指导和最后的更新审核；

TODO：计划通过 CI 自动定期完成上述文件更新和任务发布等工作，定期基于 en-comparison 开新分支，并通过 PR 把上游英文更新提交至本项目，管理员定期 Review 并修改这个 PR 的内容，即可便捷地完成教程更新。

贡献者自主提交教程上游更新 PR 时，管理员的注意事项

当有贡献者向本项目提交 PR 时，管理员应该注意，该 PR 是属于已有教程翻译中的笔误或者表述上的提升，还是基于上游英文版教程的内容更新：

1. Typo fix 和表述优化的 PR：可以直接进行 Review，没有问题时即可通过 Squash and Merge 方式合并该 PR。
2. 根据上游英文版而更新中文内容的 PR：管理员首先对该 PR 进行 Review，待没有问题可以合并时，需要进行两项操作：
   • 基于 en-comparison 新建一个分支，将该贡献者提交修改的文件所修改的内容对应的英文版本的文件提交到新建的分支，并进行检查，之后向 en-comparison 分支提交 PR；
   • 在将贡献者提交的 PR 合并到 master 分支的同时，将管理员刚提交的 PR 合并到 en-comparison 分支。

至此，更新和审核流程结束。

翻译规范

1. 本教程欢迎大家随时提交错误修改，译文提升等相关的 PR。提交翻译时，请按照本项目术语表进行术语翻译。

2. 术语表详见：本教程「英文－中文」术语对照表

3. 其他项目贡献相关注意事项请见 👉 README 中的贡献指南。

---

如有任何疑问，请通过 issue 进行提问，一般在 24 小时内就会得到管理员团队的回复 ❤️