Skip to content

Commit e5423a9

Browse files
author
OriginQuantumCloud
authored
Update CONTRIBUTING.md
1 parent a075fc8 commit e5423a9

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -125,36 +125,36 @@ alg社区基于本源量子提供的pyqpanda-algorithm开源量子算法仓库
125125

126126
如果你觉得已准备好`code review`,且预备提交PR请求,请确保:
127127

128-
- 代码遵循项目的代码风格,并且成功通过CI测试。为了方便起见,你可以先在本地执行,提前进行检查并发现报告问题。`
128+
- 代码遵循项目的代码风格,并且成功通过CI测试。为了方便起见,你可以先在本地执行,提前进行检查并发现报告问题。
129129

130-
- 如果函数或类在PR期间被修改,请相应更新。如果你的拉取请求是添加一个新的类、函数或模块,那面向用户,请确保你也添加了这些内容文档索引。``
130+
- 如果函数或类在PR期间被修改,请相应更新。如果你的拉取请求是添加一个新的类、函数或模块,那面向用户,请确保你也添加了这些内容文档索引。
131131

132132
- 确保如果你的更改将对其他用户产生影响(新功能, 弃用、移除等),你已经添加了相关说明。
133133

134-
在创建Pull Request之前,需要先fork alg [repo](https://github.com/OriginQ/pyqpanda-algorithm),然后使用这个fork中分支向官方仓库创建 Pull Request。在创建pull request时应选择推送到alg官方仓库的`master`分支。
134+
在创建Pull Request之前,需要先fork alg [repo](https://github.com/OriginQ/pyqpanda-algorithm),然后使用这个fork中分支向官方仓库创建 Pull Request。在创建pull request时应选择推送到alg官方仓库的`develop`分支。
135135

136136
fork 和 Pull Request的基本流程如下:
137137

138138
1. Fork alg的仓库 [repo page](https://github.com/OriginQ/pyqpanda-algorithm)。并把你的克隆仓库下载到你的本机。
139-
2. 从master分支创建一个新的分支`git checkout master -b new_branch_name`,其中`new_branch_name` 是你的新分支的名称。
139+
2. `develop`分支创建一个新的分支`git checkout develop -b new_branch_name`,其中`new_branch_name` 是你的新分支的名称。
140140
3. 把你的修改提交到你自己的分支。
141-
4. 如果你的克隆仓库与alg的官方仓库不同步,你需要先更新你的克隆仓库的master分支,然后再把master分支合并到你自己的分支(在合并的过程中,你可能要修改一些合并冲突):
141+
4. 如果你的克隆仓库与alg的官方仓库不同步,你需要先更新你的克隆仓库的`develop`分支,然后再把`develop`分支合并到你自己的分支(在合并的过程中,你可能要修改一些合并冲突):
142142

143143
```
144-
# Update your local master.
144+
# Update your local develop.
145145
git fetch upstream
146-
git checkout master
147-
git merge upstream/master
148-
# Merge local master into your branch.
146+
git checkout develop
147+
git merge upstream/develop
148+
# Merge local develop into your branch.
149149
git checkout new_branch_name
150-
git merge master
150+
git merge develop
151151
```
152152

153153
5. 把你修改的推送到你克隆的仓库。
154154

155155
`git push origin new_branch_name`
156156

157-
6. 经过以上的操作,你就可以把你工作 Pull Request 给alg的官方仓库了,在pull request需要选择官方仓库的``master`分支。
157+
6. 经过以上的操作,你就可以把你工作 Pull Request 给alg的官方仓库了,在pull request需要选择官方仓库的`develop`分支。
158158
7. 审查人员将对您的代码进行审核,并可能要求更改,您可以在本地执行这些操作,然后再次执行上述过程。
159159

160160
### 测试
@@ -190,3 +190,4 @@ git merge master
190190
</p>
191191

192192

193+

0 commit comments

Comments
 (0)