Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,25 @@ If you have any comments or suggestions about the documentation, please submit t

(1) Download the Asciidoc or Typora document editor.

(2) Check if the upstream repository has updates. If so, please sync to your own fork first:
(2) Before contributing, sync your fork with the upstream repository. In your local clone of your fork, check the configured remotes:

```sh
git remote -v
```
git remote

git fetch upstream
If `upstream` is missing, add it once with `git remote add upstream https://github.com/IvorySQL/ivorysql_docs.git`.

git merge upstream/main
Commit or stash any local changes before switching branches. The following example syncs the local `v5.6` branch; replace `v5.6` throughout with the branch you intend to contribute to:

git push
```sh
git fetch upstream
git switch v5.6
git merge --ff-only upstream/v5.6
git push origin v5.6
```

If the fast-forward merge fails because the branches have diverged, resolve the divergence before pushing.

(3) Familiarize yourself with the [Writing Guidelines](#writing-guidelines).

## Contribution Scope
Expand Down
17 changes: 12 additions & 5 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,25 @@

(1)下载Asciidoc或者Typora文档编辑器。

(2)检查源仓库是否有更新,如果有更新请先更新并同步到自己的仓库。如有更新请参阅以下步骤,更新至最新版本:
(2)贡献前,请先将自己的 fork 与上游仓库同步。在自己 fork 的本地克隆目录中,检查已配置的远程仓库:

```sh
git remote -v
```
git remote

git fetch upstream
如果尚未配置 `upstream`,请先执行一次 `git remote add upstream https://github.com/IvorySQL/ivorysql_docs.git`。

git merge upstream/main
切换分支前,请先提交本地修改,或使用 `git stash` 临时保存。以下示例同步本地的 `v5.6` 分支;如果要向其他分支贡献,请将所有 `v5.6` 替换为相应的分支名:

git push
```sh
git fetch upstream
git switch v5.6
git merge --ff-only upstream/v5.6
git push origin v5.6
```

如果分支历史已分叉,导致无法快进合并,请先处理分叉,再推送。

(3)熟悉[文档写作规范](#规范说明)

## 贡献范围
Expand Down
Loading