diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f7d3d63..c38c897 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,36 +1,36 @@ ## 如何贡献项目 -* 领取或创建新的 [Issue](https://github.com/yeasy/docker_practice/issues),如 [issue 235](https://github.com/yeasy/docker_practice/issues/235),添加自己为 `Assignee`。 +领取或创建新的 [Issue](https://github.com/yeasy/docker_practice/issues),如 [issue 235](https://github.com/yeasy/docker_practice/issues/235),添加自己为 `Assignee`。 -* 在 [GitHub](https://github.com/yeasy/docker_practice/fork) 上 `fork` 到自己的仓库,如 `docker_user/docker_practice`,然后 `clone` 到本地,并设置用户信息。 +在 [GitHub](https://github.com/yeasy/docker_practice/fork) 上 `fork` 到自己的仓库,如 `docker_user/docker_practice`,然后 `clone` 到本地,并设置用户信息。 - ```bash - $ git clone git@github.com:docker_user/docker_practice.git - $ cd docker_practice - $ git config user.name "yourname" - $ git config user.email "your email" - ``` +```bash +$ git clone git@github.com:docker_user/docker_practice.git +$ cd docker_practice +$ git config user.name "yourname" +$ git config user.email "your email" +``` -* 修改代码后提交,并推送到自己的仓库,注意修改提交消息为对应 Issue 号和描述。 +修改代码后提交,并推送到自己的仓库,注意修改提交消息为对应 Issue 号和描述。 - ```bash - $ # Update the content -  $ git commit -a -s -  $ # In commit msg dialog, add content like "Fix issue #235: describe ur change" - $ git push - ``` +```bash +# Update the content +$ git commit -a -s +# In commit msg dialog, add content like "Fix issue #235: describe ur change" +$ git push +``` -* 在 [GitHub](https://github.com/yeasy/docker_practice/pulls) 上提交 `Pull Request`,添加标签,并邀请维护者进行 `Review`。 +在 [GitHub](https://github.com/yeasy/docker_practice/pulls) 上提交 `Pull Request`,添加标签,并邀请维护者进行 `Review`。 -* 定期使用项目仓库内容更新自己仓库内容。 +定期使用项目仓库内容更新自己仓库内容。 - ```bash - $ git remote add upstream https://github.com/yeasy/docker_practice - $ git fetch upstream - $ git checkout master - $ git rebase upstream/master - $ git push -f origin master - ``` +```bash +$ git remote add upstream https://github.com/yeasy/docker_practice +$ git fetch upstream +$ git checkout master +$ git rebase upstream/master +$ git push -f origin master +``` ## 排版规范