|
| 1 | +# 贡献指南 |
| 2 | + |
| 3 | +如果你在使用本仓库时,发现任何问题或者有修改建议,欢迎提出来并修改,成为我们的贡献者。 |
| 4 | + |
| 5 | +## Markdown |
| 6 | +本仓库下所有文件均为 [Markdown](https://www.markdownguide.org/) 文件。要想了解 Markdown 快速上手,可以查看[快速入门](https://www.markdownguide.org/getting-started)。 |
| 7 | + |
| 8 | +## 贡献流程 |
| 9 | + |
| 10 | +### 步骤一: Fork |
| 11 | + |
| 12 | +1. 访问 https://github.com/CommunityLeadershipDevelopment/doc_guide |
| 13 | +2. 点击右上角的 `Fork`。 |
| 14 | + |
| 15 | +### 步骤二: Clone |
| 16 | + |
| 17 | +点击 **Code > Cone**。 |
| 18 | + |
| 19 | +```sh |
| 20 | +$ cd $working_dir |
| 21 | +$ git clone https://github.com/$user/CommunityLeadershipDevelopment/doc_guide |
| 22 | +``` |
| 23 | + |
| 24 | +把你克隆的仓库加成 upstream。 |
| 25 | + |
| 26 | +```sh |
| 27 | +$ cd $working_dir/CommunityLeadershipDevelopment/doc_guide |
| 28 | +$ git remote add upstream https://github.com/$user/CommunityLeadershipDevelopment/doc_guide.git |
| 29 | +``` |
| 30 | + |
| 31 | +使用 `git remote -v` 命令查看远端仓库: |
| 32 | + |
| 33 | +``` |
| 34 | +origin https://github.com/$user/CommunityLeadershipDevelopment/doc_guide.git (fetch) |
| 35 | +origin https://github.com/$user/CommunityLeadershipDevelopment/doc_guide.git (push) |
| 36 | +upstream https://github.com/$user/CommunityLeadershipDevelopment/doc_guide (fetch) |
| 37 | +upstream https://github.com/$user/CommunityLeadershipDevelopment/doc_guide (push) |
| 38 | +``` |
| 39 | + |
| 40 | +### 步骤三: 同步分支 |
| 41 | + |
| 42 | +确保你的分支和远端内容一致。 |
| 43 | + |
| 44 | +```sh |
| 45 | +$ cd $working_dir/CommunityLeadershipDevelopment/doc_guide |
| 46 | +$ git checkout master |
| 47 | +$ git fetch upstream |
| 48 | +$ git rebase upstream/master |
| 49 | +$ git push origin master |
| 50 | +``` |
| 51 | + |
| 52 | +### 步骤四: 创建分支 |
| 53 | + |
| 54 | +基于 master 创建分支。 |
| 55 | + |
| 56 | +```sh |
| 57 | +$ git checkout -b myfeature |
| 58 | +``` |
| 59 | + |
| 60 | +### 步骤五: 修改内容 |
| 61 | + |
| 62 | +在新创建的分支中修改内容。 |
| 63 | + |
| 64 | +### 步骤六: 提交(Commit) |
| 65 | + |
| 66 | +提交修改。 |
| 67 | + |
| 68 | +```sh |
| 69 | +$ git add <filename> |
| 70 | +$ git commit -m "$add a comment" |
| 71 | +``` |
| 72 | + |
| 73 | +提交修改后,你可能需要来回修改、提交几轮,可以参考使用以下命令。 |
| 74 | + |
| 75 | +```sh |
| 76 | +$ git add <filename> (used to add one file) |
| 77 | +git add -A (add all changes, including new/delete/modified files) |
| 78 | +git add -a -m "$add a comment" (add and commit modified and deleted files) |
| 79 | +git add -u (add modified and deleted files, not include new files) |
| 80 | +git add . (add new and modified files, not including deleted files) |
| 81 | +``` |
| 82 | + |
| 83 | +### 步骤七:把变更推到远端仓库(Push) |
| 84 | + |
| 85 | +完成修改后,需要把修改内容推到你 fork 的远端仓库。 |
| 86 | + |
| 87 | +```sh |
| 88 | +$ git push origin myfeature |
| 89 | +``` |
| 90 | + |
| 91 | +### 步骤八: 创建 PR(pull request) |
| 92 | + |
| 93 | +1. 访问你 fork 的仓库 https://github.com/$user/CommunityLeadershipDevelopment/doc_guide 。 |
| 94 | +2. 点击 `Compare & pull request` 。 |
| 95 | + |
| 96 | +### 步骤九: 审校(review) |
| 97 | +提交 PR 后,可以找人帮忙审校。审校确认无误,审校人会审批通过 (approve)并将你的修改合并到仓库(merge)。 |
| 98 | + |
| 99 | +恭喜你成为我们的贡献者! |
| 100 | + |
| 101 | +> **建议** |
| 102 | +> PR 内容修改少,会更容易审校、合并。 |
| 103 | +> 如果你要修改的内容很多,涉及多个文件,可以分开提 PR。 |
0 commit comments