diff --git a/README_zh.md b/README_zh.md index 4301e8a9..178e81f2 100644 --- a/README_zh.md +++ b/README_zh.md @@ -15,18 +15,33 @@ (1)下载Asciidoc或者Typora文档编辑器。 -(2)检查源仓库是否有更新,如果有更新请先更新并同步到自己的仓库。如有更新请参阅以下步骤,更新至最新版本: +(2)贡献前,请先将自己的 fork 与上游仓库同步。在自己 fork 的本地克隆目录中,检查已配置的远程仓库: +```sh +git remote -v ``` -git remote +如果尚未配置 `upstream`,请先执行一次 `git remote add upstream https://github.com/IvorySQL/ivorysql_docs.git`。 + +切换分支前,请先提交本地修改,或使用 `git stash` 临时保存。请选择 PR 要提交到的目标分支,例如 `master` 或 `v5.6`。将下文所有 `` 替换为实际分支名: + +```sh git fetch upstream +git switch +git merge --ff-only upstream/ +git push origin +``` -git merge upstream/main +如果本地尚无目标分支,请将上述 `git switch ` 步骤替换为以下命令。它会明确创建本地分支并跟踪自己 fork 的对应分支,避免两个远程仓库都有同名分支时产生歧义: -git push +```sh +git switch -c --track origin/ ``` +然后继续执行上述合并和推送步骤。 + +如果分支历史已分叉,导致无法快进合并,请先处理分叉,再推送。 + (3)熟悉[文档写作规范](#规范说明) ## 贡献范围 @@ -100,7 +115,7 @@ antora -v 然后耐心等待,当成功运行结束后,你就可以到../demo 中查看自己生成的网页了。 -检查之后,你就可以开始提交[PR](https://github.com/IvorySQL/ivorysql_docs/blob/v5.0/CN/modules/ROOT/pages/v5.0/32.adoc),感谢您对社区的贡献^ _ ^,我们会在审核过后,考虑是否更新网站。 +检查之后,你就可以开始提交[PR](./CN/modules/ROOT/pages/master/contribution/contribution_guide.adoc),感谢您对社区的贡献^ _ ^,我们会在审核过后,考虑是否更新网站。 ## Autobuild