mirror of https://github.com/jumpserver/jumpserver
如何正确的姿势提交PR
parent
5357b35e5b
commit
0a02f42090
|
@ -0,0 +1,46 @@
|
|||
如何正确的姿势提交PR
|
||||
===================
|
||||
|
||||
GitHub 仓库
|
||||
-----------------
|
||||
|
||||
### 新建一个github账户,如果你没有的话
|
||||
|
||||
[Join GitHub](https://github.com/join)
|
||||
|
||||
### Fork repo 到你自己的账户里
|
||||
|
||||
### 下载repo到本地
|
||||
|
||||
git clone https://github.com/<your username>/jumpserver.git
|
||||
cd jumpserver
|
||||
|
||||
### 添加远端路径
|
||||
|
||||
git remote add upstream https://github.com/jumpserver/jumpserver.git
|
||||
|
||||
### 从 upstream 拉取最新的代码
|
||||
|
||||
git fetch upstream
|
||||
git rebase upstream/master
|
||||
|
||||
|
||||
值得注意的事
|
||||
---------------
|
||||
我们希望你的代码能安装pep8的规范并且足够考虑到异构系统的情况,如你觉得需要改进jumpserver的数据库,请一并提交新老数据库的迁移方案。
|
||||
对于编辑器,我们没有强烈的要求,但推荐你使用正版的[PyCharm](https://www.jetbrains.com/pycharm/)。
|
||||
当然我们也希望你增加的新功能能有测试用例。
|
||||
版权方面,如你提交PR,我们则视为你同意将你的代码以当前Jumpserver的License进行发布,故而请不要提交你公司的代码以此来避免不必要的麻烦。
|
||||
|
||||
当然,一个好的PR需要具备如下几点:
|
||||
* 有过讨论或者建立过跟踪的issue
|
||||
* 一个PR仅仅只有一个commit
|
||||
* 一个PR仅仅只有一个feature或者改进
|
||||
* 不改变与您的更改没有直接关系的代码(例如,如果您想重构/改进现有代码(这需要单独讨论,开issue),当然如果你仅仅想重构或者改进现有的代码,也是如此)
|
||||
* 必须通过所有的测试用例
|
||||
* 请在upstream master上做rebase
|
||||
* 我们通常仅接受针对master的PR,针对某版本的hot fix请先开issue讨论再着手代码修改
|
||||
* 每个PR需要写明做了哪些功能性的修改
|
||||
* 我们会认真对待每个PR,当然如果该PR发生质疑时,我们希望PR的作者能及时参与讨论,对于有争议的PR两周内作者或者其他人没有跟进回复,我们可能会考虑关闭这个PR
|
||||
|
||||
|
Loading…
Reference in New Issue