gitee上提交PR和issue流程和注意事项

MindSpore已在Gitee和GitHub上开源,所有人都可参与~

作为社区贡献的主要途径之一,Gitee上提交PR还是有很多小伙伴不熟悉的,通过前两次活动我们也发现了这一问题,为此写了这篇注意事项,希望给大家作参考,同时期待大家的补充与指正!

Gitee:https://gitee.com/mindspore

GitHub:https://github.com/mindspore-ai

写在最前面,参与贡献必须先签署CLA,具体方法请参考下方的“规范”

流程:

提交issue
进入MindSpore相应的仓,这里我们以主仓mindspore为例。

进入主仓https://gitee.com/mindspore/m...(注意是进入主仓,不是自己fork下来的仓)

在下图位置点击”+issue"

issue.PNG

填写issue详细描述和标题,点击创建。(issue描述建议以英文为主)

issue需要填写负责人,参考活动帖的“注意事项”,每次活动会发布负责人。

提交PR
提交流程不熟悉的,可以参考这两篇文章。

《git + gitee 入门实践》

(包含git安装,简单使用,代码托管等内容)

《git+码云提交PR流程记录》

(本地新建代码仓、拉取远程代码仓内容、提交到远程仓库,提交PR等内容)

《git 解冲突流程》

(发生冲突时看这里!)

PR需要填写审核人,参考活动帖的“注意事项”,每次活动会发布审核人。

规范:

主要参考《贡献文档》,以下几点为现有问题总结:

  1. CLA签署问题,新人需签署CLA。(基本前提,很重要!)

签署方法:

1)在自己的PR下评论:/check-cla,短暂等待后,自动回复弹出,点击“here”(如下图)。或者直接访问:https://clasign.osinfra.cn/si...

here.PNG

2)根据身份选择签署,外部用户一般签署第三个“个人CLA”

CLA.PNG

3)填写带“*”号的内容并打勾,签署成功。(没绑定邮箱的需要去gitee绑定邮箱)

4)最后去PR评论:/check-cla。提示成功即可。

  1. 很多用户存在提交PR后不管的现象,需要强调提交后持续关注PR的评论情况,及时修改尽早合入。修改之后,自己评论:/retest,重新发起自动检测。
  2. PR格式问题,需要关联相关issue。

image.png

  1. 提交到同一路径,如果是图类,尽量保证原图大小,不要过大或过小。
  2. 全文字体统一,代码注释使用英文,以及若干markdown规范问题。
  3. 不能使用翻译工具直接翻译,不要逐字翻译,这样出来的效果很中式。应该按照自己的理解翻译,且译文应该符合英文阅读习惯。
  4. 用词规范:1)专有名词保持书写正确,例如:AlexNet,不要写成alexnet或者Alexnet。

                2)用词符合业界习惯,例如:reasoning和inference都有推理的意思,但是通常业界使用inference。
    
  5. 语法规范:1)标点符号使用正确,不要中英文标点混用。

                2)主谓宾结构完整,不产生歧义。
    
  6. 标题规范:1)标题首字母大写。

                2)标题若动词开头,应采用动名词形式,即doing形式。
    
                3)标题应尽量简短干练。
    

大家都明白了么,有个练手机会,https://bbs.huaweicloud.com/f...大家尝试一下,有问题可以评论哦,我会回复的。

你可能感兴趣的