Skip to content

PR贡献流程

开源指南

1. 从上游仓库同步(sync fork)

Github 文档:syncing-a-fork

为了防止上游仓库的更改导致冲突,在pr之前要先sync frok, 解决冲突(尽量将冲突在本地解决)。

sync-fork

2. 从远程仓库同步 && 本地解决冲突

  1. 在本地使用git pull命令从远程仓库同步代码

  2. 如果没有冲突,那太好了。如果存在冲突,请参考 about-merge-conflicts解决

3. 提交commit && 推送到远程仓库

代码格式化

提交commit之前请使用 mvn spring-javaformat:apply进行代码格式化

  1. 一个pull request中只能一个commit。如果有多个commit,使用 Rebase命令合并commit
  2. 每个commit都要在CHANGELOG中添加对应的修改记录。
  3. git push 或则 git push -f(合并了远程commit添加 -f)推送commit到远程仓库

4. 创建 pull request

  1. 创建 pull request

image

  1. 认真填写title和commenttitle简单描述你的意图,comment中详细描述过程。可以参考已关闭的pr)。

image

  1. 处理review。如果你的pull request很完美,会直接被社区采纳。如果社区review发现问题,会有评论,我们可以直接讨论,最后解决问题了,要点击 Resolve conversation

handle-reviews

注意:如果解决问题期间出现了多个commit,我们要使用rebase命令合并commit!

基于 MIT 许可发布