Skip to content

提交PR时需要注意的事项 #68

@orbitchen

Description

@orbitchen
  1. 在提交PR之前将自己的分支与主干对齐,在本地处理可能的冲突而不是在PR合流的时刻。
  2. 只引入必要的代码,其他的代码如果存在功能性错误可以修改,但是需要在PR的描述中说明。

错误例子:
在编码过程中我看见有些文件里空行太多,想把那些空行去掉。
代码里左大括号都要换行,这不符合我的风格,我要给它改过来。
我的IDE配置了自动formatter,commit的时候这些格式改动都自动上去了。
main文件和场景文件我自己测试的时候改了一下,commit的时候忘了取消勾选。

正确例子:
这里有一个小的功能性错误,我修改了之后放进了我的PR,并且在描述中说明了这一点以防冲突。

  1. 考虑编码问题,PR的标题使用英文。标题不做严格的格式限制,但是最好简单陈述这个PR干了什么。
  2. PR的说明里尽量详细描述我的这个PR实现了哪些功能或者修改了哪些东西,以及引入了哪些bug。如果引入了新功能,最好加上简单的测试结果。

可以供参考的范例:
#66
#53

建议使用的软件:github desktop https://desktop.github.com/
Sourcetree https://www.sourcetreeapp.com/
在提交commit前确保只勾选需要提交的文件。

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions