Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

37 lines (28 loc) · 1.35 KB

欢迎所有的PR(Pull request)。 如果有任何有意思或者更合适的标题可以替换当前例子的现有标题,欢迎随时联系我或者提issues告诉我。

我的目标是让这个仓库里的例子尽可能的更加易读并且更加有趣。

如果你有一个跟重要的更新建议,希望你可以先提交一个issues, 讨论后再提交一个PR。

如果你准备为这个仓库增加一个新的例子,请先把例子提交到issues,等大家讨论后在提交PR。

你可以使用下面的模板来增加新的例子:

 ### ▶ 这是一个标题 *
 首先是例子的标题,如果某个标题后面带有星号,说明这一段是最新的一个版本加上的。
 ```py
 # 介绍会在这里写一些初始化代码
 # 为下面的神奇时刻做准备...
 ```

 **输出 (Python version):**
 ```py
 >>> python语句,执行某个命令
 一些神奇的输出
 ```
 (可选): 有可能会介绍一下输出的内容


 #### 💡 解释:

 * 简短的介绍发生了什么和为什么会产生这些输出。
   ```py
   写一些初始化代码
   ```
   **Output:**
   ```py
   >>> 触发相应代码 # 这些代码会揭示为何会有上方那些神奇的输出内容
   ```