Jelajahi Sumber

doc: 完善贡献者指南的readme (#12)

LoGin 10 bulan lalu
induk
melakukan
d47dca78b7
4 mengubah file dengan 64 tambahan dan 2 penghapusan
  1. 1 0
      .vuepress/config.js
  2. 56 2
      contributors/README.md
  3. 3 0
      contributors/cheat-sheet.md
  4. 4 0
      contributors/expectation.md

+ 1 - 0
.vuepress/config.js

@@ -82,6 +82,7 @@ export default defineUserConfig({
                             '/contributors/guide.md',
                             '/contributors/cheat-sheet.md',
                             '/contributors/code_of_conduct.md',
+                            '/contributors/expectation.md',
                         ]
                     }
                 ],

+ 56 - 2
contributors/README.md

@@ -2,6 +2,60 @@
 
 欢迎来到DragonOS社区的贡献文档。如果你愿意加入社区,我们将感到格外的兴奋!
 
-## 开始
+## 欢迎!
+
+你想加入一个完全自主的服务器系统内核的研发吗?这篇文档将会给你一些指引,带你加入DragonOS社区的开发!
+
+这篇文章将会带你了解DragonOS社区的组成,帮助你找到适合你参与的地方!根据本指南,加入社区开发后,你的代码将会被审查、被合并入主线,甚至...你也能审查其他人的代码!
+
+准备好了吗?那请继续往下看!
+
+
+## 先决条件
+在向 DragonOS 提交代码之前,您需要完成以下先决条件。在您的第一次提交时,这些步骤会由一个机器人自动检查。完成这些步骤将使您的首次贡献更加顺利:
+
+### 创建一个 GitHub 账户
+在开始之前,您需要访问 [GitHub 注册页面](http://github.com/signup) 来创建一个 GitHub 用户账户。
+
+### 签署 CLA
+
+在您能够为 DragonOS 做出贡献之前,您需要签署贡献者许可协议(CLA)。
+
+CLA是为了保护您、所有贡献者的合法权益,您将会得到来自所有贡献者的无偿的专利、软著授权
+
+**注意**: 由于社区目前的CLA系统尚未完善,因此您目前暂时不需要签署CLA。当基础设施完善后,将会由一个CLA机器人
+提醒您签署CLA。
+
+### 行为准则
+请确保阅读并遵守我们的 [行为准则]。
+
+### 设置您的开发环境
+
+如果您计划提交代码更改,请查看 [构建DragonOS](https://docs.dragonos.org/zh-cn/latest/introduction/build_system.html) 页面了解如何设置您的环境。
+
+### 社区期望与角色
+DragonOS 是一个社区项目。因此,它完全依赖于其社区来提供一个富有成效、友好和协作的环境。
+- 阅读并审查 [社区期望],了解代码和审查的期望。
+- 参见 [社区成员资格] 了解各种贡献者角色的不同责任。
+- 随着您不断积累经验,您的贡献者级别将会提高(可能需要您提出申请)
+
+## 社区
+
+DragonOS 是一个充满活力、友善的开源社区。像许多开源项目一样,它依赖于新成员成为定期代码贡献者。[社区成员资格]文档涵盖了社区成员流程和角色。
+我们真诚的邀请您加入DragonOS开源社区!
+
+### 沟通
+
+- [社区交流]文档描述了DragonOS社区的沟通交流平台、方式。
+
+
+### 导师制
+
+我们设有导师制来帮助新成员加入DragonOS社区,请查看[导师制文档]。
+
+[行为准则]: ./code_of_conduct.md
+[社区成员资格]: governance/community-membership.md
+[社区期望]: ./expectation.md
+[社区交流]: /communication/README.md
+[导师制文档]: /mentorship/README.md
 
-TODO

+ 3 - 0
contributors/cheat-sheet.md

@@ -1 +1,4 @@
 # 贡献者备忘录
+
+
+// TODO

+ 4 - 0
contributors/expectation.md

@@ -0,0 +1,4 @@
+# 对社区成员的期望
+
+// TODO
+