编写指南

欢迎你参加《开源指北》的编写工作，会有更多人通过你的分享了解开源、参与开源、爱上开源。

参与须知

格式

内容

  • 撰写的内容需符合该部分主题

  • 不求文风华丽，只需结构清晰，表述简洁，易读易懂

  • 欢迎原创内容和新解读、新观点，不欢迎大篇幅摘抄和生搬硬套

  • 涉及参考资料的内容需要标明来源出处并获得作者授权（或符合作品许可证）

参与流程

输入图片说明
具体操作指引

  1. 从目录中选择自己想要参与编写的部分后，前往 Issue 页面 进行内容认领。

  2. 选择自己想要认领的内容部分，对该 Issue 进行评论，评论内容为 「作者姓名+预计完成时间+备注」 ，如 「Gitee 酱，预计 9 月 18 日完成部分内容」 ，收到用户名为「Gitee」的账号回复 「已确认」 后，代表你就可以开始编写工作，该 Issue 会被移至 「编写中」 状态。 编写指南 - 图2

  3. 完成编写后，选择仓库中对应部分的文件进行 轻量级 PR ，审查团队将会对内容进行格式规范初审，通过后将会对 PR 进行合并，对应 Issue 进入 「需补充」 或 「已完成」 状态。 编写指南 - 图3

  4. 审校专家团队会对 「已完成」 的内容进行内容正确性复审，通过后该内容对应 Issue 进入 「已审核」 状态，代表该部分内容已确认收录进《Gitee 开源指北》中。

任务状态说明

  • ⏳ 待编写

该部分内容为空白，需要熟悉该部分的你将经验分享给大家。

该部分内容可在 符合参与须知的情况下 自由提交 PR。

  • 📝 编写中

该部分内容已经有人开始编写，但你同样可以参与，我们会将不同作者的内容综合编辑后展示，同时参与的开发者都可获得编写人员的身份。

该部分内容可在 符合参与须知的情况下 自由提交 PR。

  • 🏷 需补充

该部分内容并没有全部完成，需要对该主题进行更加详细的补充。

该部分内容仅接受 符合主题且对已有内容进行补充 的 PR。

  • 📔 已完成

该部分内容已经完成，但还没有经过审校专家团队进行审核。

该部分仅接受 原则性错误修改/额外信息补充 的 PR。

  • ✅ 已审核

该部分内容已经完成，并经过了审校专家团队的审核。

该部分接受 原则性错误修改/过时信息更新/额外信息补充 的 PR。