如何为 Cangjie-TPC 贡献代码
1 熟知 Cangjie 社区行为守则
Cangjie-TPC 是 Cangjie 社区用于汇集基于仓颉编程语言开发的开源三方库的主干仓,帮助开发者方便、快捷、高质量构建仓颉程序,完全依赖于社区提供友好地开发和协作环境。在参与社区贡献之前,请先阅读并遵守Cangjie-TPC社区行为守则(Cangjie Community Code of Conduct)。
2 熟知 Cangjie 社区治理规则
3 根据您的目的选择贡献流程
3.1 贡献仓库
STEP 1 提交创建项目申请 issue
请点击下方链接,选择项目创建申请 issue 模版,按照模版,详尽填写信息(如果创建项目申请 issue 不够详细,社区不会通过该申请),并提交 issue
STEP 2 提交创建项目申请 email
请点击下方链接,下载项目创建申请 email 模版,按照模版,详尽填写信息(如果创建项目申请 email 不够详细,社区不会通过该申请),并向 [email protected] 发送该邮件
注意:邮件附件必须包括项目初始化内容(包含README,LICENSE,CHANGELOG,cjpm.toml),点击下方链接,下载项目初始化模版,请以项目名称.zip方式返回
STEP 3 Cangjie-TPC 组织评审
Cangjie-TPC 社区将在5个工作日内进行评审,评审结果将以邮件形式返回
STEP 4 签署 CLA 协议
评审通过后,请点击下方链接,下载 CLA 模版,打印签署后,回复邮件至 [email protected]
注意:
-
CCLA 为公司/组织/单位的贡献协议
-
ICLA 为个人贡献协议
STEP 5 准入孵化
签署 CLA 协议后,Cangjie-TPC 社区将在5个工作日内创建项目,并邀请您加入项目
- 您的项目将首先以孵化状态加入Cangjie-SIG组织
- 若您的项目隶属于三方库招募列表,则将基于项目质量及社区开源规则进行项目审查,通过后在Cangjie-TPC组织中公开
- 若您的项目暂时不符合上述条件,则将视情况在Cangjie-SIG中公开、继续孵化或转入Cangjie-Retired组织
Cangjie-TPC组织、Cangjie-SIG组织和Cangjie-Retired组织同属Cangjie-TPC社区管辖
STEP 6 准出毕业
毕业相关质量标准以及基础设施正在建设中,敬请期待
3.2 贡献 PR
STEP 1 将 issue 分配给自己
请针对具体缺陷/需求提交 issue,并将该 issue 分配给自己
STEP 2 编写代码与测试用例
针对解决该 issue 编写代码以及测试用例(如果您的 issue 没有测试用例可能不会被接纳)
STEP 3 提交 PR 并勾选 CLA
提交 PR 并勾选 CLA,PR 模板如下:
标题:
[项目名称][需求/缺陷]:PR 标题
正文:
[issue number]:
[impact files]:
(请描述您的pr所做的工作)
STEP 4 由 Committer 审核并合入代码
由Committer对PR进行审核,通过审核后即可合入代码。