From 4ff315a86646cabda7e21c5d663ffeefd58e09d0 Mon Sep 17 00:00:00 2001
From: "[Dechin.Phy]" <dechin.phy@gmail.com>
Date: Tue, 22 Sep 2020 13:00:13 +0800
Subject: [PATCH] =?UTF-8?q?=E5=9C=A8readme=E4=B8=AD=E6=9B=B4=E6=96=B0`?=
 =?UTF-8?q?=E5=A6=82=E4=BD=95=E8=B4=A1=E7=8C=AE`=E7=9A=84=E6=A8=A1?=
 =?UTF-8?q?=E5=9D=97?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)

diff --git a/README.md b/README.md
index 2c8d9524..a910e400 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,64 @@ python3 app2.py
 
 如果是 windows 环境下，可以通过文件夹中的 pyminer.bat 作为入口运行程序。
 
+#### 如何贡献
+
+1. 在[PyMiner主页](https://gitee.com/py2cn/pyminer)点击Fork，生成你自己的PyMiner库，生成成功之后可以在路径`https://gitee.com/your_name/pyminer`下看到；
+
+2. 将你自己的PyMiner库下载到你的本地：
+
+   ```bash
+   git clone https://gitee.com/your_name/pyminer.git && cd pyminer/
+   ```
+
+3. 首先确认库的远程链接情况，一般刚克隆下来的库都需要执行该操作，否则会影响Pull Request的提交：
+
+   ```bash
+   #执行以下指令确认远程链接情况
+   git remote -v
+   #如果未链接到远程仓库，则需要执行以下指令
+   git remote add upstream https://gitee.com/py2cn/pyminer.git
+   #执行成功后，再执行如下指令，应该可以看到4行链接
+   git remote -v
+   ```
+
+4. 在本地创建一个依照特性来命名的分支，如修改`README.md`：
+
+   ```bash
+   git checkout -b modify_readme
+   ```
+
+5. 执行你的增删改操作，如果你的修改只涉及一个文件，如修改了`README.md`，则只需要执行：
+
+   ```bash
+   git add README.md && git commit -m '修改了README.md文件，补充了如何贡献模块' && git push --set-upstream origin modify_readme
+   ```
+
+6. 如果不涉及多个commit的情况，则只需要在[pulls](https://gitee.com/py2cn/pyminer/pulls)里面直接新建一个Pull Request，源分支选择你新增的特性分支，目标分支按照需求更新到pyminer的`master`分支或者`dev`分支，然后等待评审的回复即可。如果涉及到多个commit，请按照第7步操作继续往下操作，执行变基。
+
+7. ```bash
+   #假如你提交了1个特性`feature1`
+   git add feature1.py
+   git commit -m 'Add feature1'
+   git push
+   #然后你又想同时提交1个新特性`feature2`，但是还没提交PR
+   git add feature2.py
+   git commit -m 'Add feature2'
+   git push
+   #这时候你需要执行变基，将历史的2个commit合并成一个来提交，提升评审效率
+   #先查看想要合并的历史commit
+   git log --oneline --graph
+   #例如合并2个commit
+   git rebase --interactive HEAD~2
+   #按照指示进行操作，一般用i(insert)进入编辑操作
+   #以下示例说明将commit2合并到commit1的场景
+   pick commit1 -> pick commit1 #保留commit1
+   pick commit2 -> fixup commit2 #去掉commit2的说明内容
+   #按esc之后输入`:wq`保存更改
+   #最后再强制提交，保存变基的操作，这样变基的流程就结束了，可以回到第6步进行提交
+   git push --force
+   ```
+
 
 #### 联系我们
 
-- 
Gitee