非官方测试版翻译
本页面由 PageTurner AI 翻译(测试版)。未经项目官方认可。 发现错误? 报告问题 →
贡献文档
修改内容及原因
文档更新迅速且持续变化。请仔细思考您要修改的内容及原因:这些改动将来能带来什么价值?重大重写或新增页面应谨慎考虑,并在我们的文档 Matrix 聊天室中协调。
请进行自检
在最终确定修改前,请对审阅者保持礼貌,至少使用拼写检查工具(例如 apsell)检查您的改动,必要时还可进行语法检查。使用AI工具辅助可以接受,但请节制地用于_生成_内容。请务必重新阅读生成内容并按要求调整。我们尊重个人写作风格,但审阅过程中大量的来回沟通往往源于此类小问题,因此请先尽己之力确保无误。
同行校对
对于重大修改,我们鼓励采用同行校对机制。与其提交庞大PR后在代码行间反复修改,建议将新建/更新的文档放入HackMD等协作编辑器中,并分享至文档Matrix聊天室。您可通过聊天室与协作编辑器的配合,在PR之外完成拼写、语法和格式的逐行校对。待双方对修改达成共识后,再提交pull request。
虽然看似"额外工作",但对于实质性修改,这应是整体流程的小环节,能确保最终审阅更顺畅。
同行评审
由于文档仓库的 PR 数量庞大且规模不一,部分 PR 可能耗时较长甚至被搁置。
提交 PR 前(或立即之后),请找他人未获评审的 PR 进行通读审阅。确保内容合理、校对完善,并提交 GitHub 评审意见。必要时请指出修改建议。这能形成互助循环——下位贡献者将评审您的 PR。
博客文章
博客文章仅限团队成员撰写,不接受外部投稿。博客需遵循上述流程,并额外获得核心团队终审。文章可能因关联事件(如版本发布)保持草稿/评审状态,发布日期应始终体现最终(预期)发布时间。