PR贡献流程
1. 从上游仓库同步(sync fork)
为了防止上游仓库的更改导致冲突,在pr
之前要先sync frok
, 解决冲突(尽量将冲突在本地解决)。
2. 从远程仓库同步 && 本地解决冲突
在本地使用
git pull
命令从远程仓库同步代码如果没有冲突,那太好了。如果存在冲突,请参考 about-merge-conflicts解决
3. 提交commit && 推送到远程仓库
代码格式化
提交commit之前请使用 mvn spring-javaformat:apply
进行代码格式化
- 一个
pull request
中只能一个commit
。如果有多个commit
,使用 Rebase命令合并commit - 每个
commit
都要在CHANGELOG
中添加对应的修改记录。 git push
或则git push -f
(合并了远程commit
添加-f
)推送commit
到远程仓库
4. 创建 pull request
- 创建 pull request
- 认真填写title和comment。
title
简单描述你的意图,comment
中详细描述过程。可以参考已关闭的pr
)。
- 处理review。如果你的
pull request
很完美,会直接被社区采纳。如果社区review
发现问题,会有评论,我们可以直接讨论,最后解决问题了,要点击Resolve conversation
。
注意:如果解决问题期间出现了多个commit,我们要使用rebase命令合并commit!