readme.md

Author: guozhen3

README.md

@@ -1,3 +1,5 @@
+## 📚 介绍
+
 告别枯燥，告别枯燥，致力于打造 Python 经典小例子、小案例。 
 
 当前库已有 **300** 多个实用的小例子、小案例 。
@@ -8,10 +10,28 @@
 
 <img src="img/Python小例子.jpg" width="20%"/>
 
+
+
 如果转载本库小例子、小案例，请备注下方链接：
 
 Python小例子 https://github.com/jackzhenguo/python-small-examples
 
+
+
+## 🤝 贡献
+
+欢迎贡献小例子，修改已有 bug，参考  [贡献方法](./contributing.md) 
+
+
+
+## ✅ License
+
+允许按照要求转载，但禁止用于任何商用目的！
+
+
+
+## 🔨 迭代第二版
+
 现在正在按照如下施工计划，迭代此库，欢迎持续关注。
 
 ![image-20200624093723980](./img/image-20200624093723980.png)
@@ -110,7 +130,7 @@ https://github.com/jackzhenguo/python-small-examples
 
 
 
-
+## 🖥 完成第一版
 
 ### 一、Python基础
 

contributing.md

@@ -0,0 +1,27 @@
+# 贡献指南
+
+> 参考 ant design [贡献指南](https://ant.design/docs/react/contributing-cn)
+
+这篇指南会指导你如何为 `python-small-examples` 贡献一份自己的力量，请在你要提 issue 或者 pull request 之前花几分钟来阅读一遍这篇指南。
+
+## 透明的开发
+
+我们所有的工作都会放在 [GitHub](https://github.com/jackzhenguo/python-small-examples) 上。不管是核心团队的成员还是外部贡献者的 pull request 都需要经过同样流程的 review。
+
+## 分支管理
+
+长期维护主分支 master。如果你要修一个 bug，那么请发 pull request 到 master。
+
+## 新增功能
+
+如果你想新增一个 小例子，我们建议你先建立一个 issue，说明该 小例子 的应用场景及用法。
+
+## Pull Request
+
+我们会关注所有的 pull request，会 review 以及合并你的代码，也有可能要求你做一些修改或者告诉你我们为什么不能接受这样的修改。
+
+在你发送 Pull Request 之前，请确认你是按照下面的步骤来做的：
+
+1. 基于 [正确的分支](#分支管理) 做修改。
+
+2. 如果你修复了一个 bug 或者新增了一个功能，请确保写了相应的测试，这很重要。