阅读并遵循项目的指导方针和行为准则。这里是在哪里可以找到它们的截图第一次的贡献者而且以前的贡献者.
- 让一个分支
- 请为您正在处理的每个问题创建一个单独的分支。不要更改默认的分支(例如。
主
,开发
)你的叉子。
- 尽快发布你的代码
- 描述你的拉请求
- 使用存储库拉请求模板中指定的格式。完全填充模具为最大的冗长。
- 通过替换标记实际的发行号
# (issue_number)
如。# 42
.当您的PR被合并时,这将关闭问题。
- 通过替换标记实际问题作者
@(作者)
如。@issue_author
.这就把这个问题的记者带入了对话中。
- 在你的清单上加上一个
x
在[ ]
如。[x]
.这可以检查你的待办事项列表。勾选的选项越多越好。
- 详细描述你的改变。太多的细节总比太少好。
- 描述您如何测试您的更改。
- 检查预览选项卡,确保Markdown被正确渲染,并且所有的标签和引用都被链接了。如果不是,返回并编辑Markdown。
截图:填充的拉请求
- 请求审查
- 一旦你的PR准备好了,从标题中删除“[在制品]”字样和/或将其从公关草稿改为常规公关。
- 如果一个特定的审查员没有自动分配,请请求审查从项目维护者和任何其他感兴趣的方手动。
- 加入反馈
- 如果你的PR收到了“更改请求”的评论,你就需要处理反馈并通过推送到相同的分支而更新PR。你不需要关闭PR然后打开一个新的。
- 一定要re-request审查一旦您在代码评审后进行了更改。
截图:如何申请复核?
- 要求重新检查可以清楚地表明,您已经处理了请求的更改,而这是在等待维护者,而不是相反。
截图:“更改请求”和“审核要求”的区别
代码的指导方针
- 编写全面而健壮的测试,覆盖您在工作中所做的更改。
- 遵循您正在使用的语言和框架的适当代码样式标准(例如Python的PEP 8)。
- 编写可读的代码——保持函数小且模块化,并对变量进行描述性命名。
- 完整地记录代码。
- 确保所有现有测试都通过。
- 面向用户的代码应该支持以下浏览器:
- Chrome (Webkit-Blink / 22+)
- 火狐(Gecko / 28+)
- 边缘(铬基/ 12+)
- Opera (chrome - blink / 12.1+)
- Safari(苹果的Webkit / 7+)
- 即11(三叉戟)
我们的目标是在三个工作日内审查撤销请求。*.如果已经超过三个工作日,您仍未收到任何反馈,请随时与我们联系。
*CC员工周一到周五上班,周末和国家法定节假日不上班(具体节假日视个人所在地区而定)。CC每年在平安夜和元旦之间以及CC全球峰会之后的几天关闭。此外,在CC全球峰会和一年两次的员工聚会等活动期间,我们的可用性也有限。