1 | ## CONTRIBUTING.md
|
2 |
|
3 | 感谢所有社区贡献者,为助力完善`Tinper`全系列产品,本篇针对*bug反馈* & *pull request流程*作出说明
|
4 |
|
5 | * [Bug反馈](#bug)
|
6 |
|
7 | * [Pull Request流程图示](#pull)
|
8 |
|
9 |
|
10 |
|
11 | <h3 id="bug">Bug反馈</h3>
|
12 |
|
13 | 1.提交途径
|
14 |
|
15 | * 推荐使用issue,
|
16 |
|
17 | > 简单,拖拽即可上传截图,方便反馈存档,利于帮助其他存在问题的人,避免重复问题
|
18 |
|
19 | 2.提交内容
|
20 |
|
21 | 针对存在问题反馈不够明确,建议提交包含以下内容,目前提供了一个[在线模板可供参考](https://github.com/iuap-design/neoui/issues/new?title=Bug:%20&body=**%E9%97%AE%E9%A2%98%E6%8F%8F%E8%BF%B0**%0A%EF%BC%88%E6%8F%8F%E8%BF%B0%E4%B8%80%E4%B8%8B%E9%97%AE%E9%A2%98%EF%BC%89%0A%0A**%E7%94%9F%E4%BA%A7%E7%8E%AF%E5%A2%83**%20%0A-%20%E6%B5%8F%E8%A7%88%E5%99%A8%E5%8F%8A%E7%89%88%E6%9C%AC%EF%BC%9A%20%0A-%20%E6%BC%94%E7%A4%BA%E5%9C%B0%E5%9D%80:%20%0A-%20%E6%B5%8F%E8%A7%88%E5%99%A8%E6%8A%A5%E9%94%99:%20%0A-%20%E6%88%AA%E5%9B%BE:),个人填写建议包含以下内容:
|
22 |
|
23 | ```
|
24 | **问题描述**
|
25 | (描述一下问题)
|
26 |
|
27 | **生产环境**
|
28 | - 浏览器及版本:
|
29 | - 演示地址:
|
30 | - 浏览器报错:
|
31 | - 截图:
|
32 | ```
|
33 |
|
34 |
|
35 |
|
36 | <h3 id="pull">Pull Request流程图示</h3>
|
37 |
|
38 | 以 [neoui](https://github.com/iuap-design/neoui) 仓库为例:
|
39 |
|
40 | 1. Fork仓库到个人Respository目录:进入仓库,点击`Fork`
|
41 |
|
42 | ![Fork](https://cloud.githubusercontent.com/assets/11772494/18979569/bf247980-86fe-11e6-9b56-6411f5a55a0e.png)
|
43 |
|
44 | 2. Clone到本地
|
45 |
|
46 | ```
|
47 | $ git clone git@github.com:onvno/neoui.git
|
48 | ```
|
49 |
|
50 | 3. 创建分支
|
51 |
|
52 | ```
|
53 | $ git checkout -b fixer
|
54 | ```
|
55 |
|
56 | 4. 修改后提交
|
57 |
|
58 | ```
|
59 | $ git add .
|
60 | $ git commit -m "fix:some bug"
|
61 | $ git push origin fixer
|
62 | ```
|
63 |
|
64 | 5. 提交`pull request`:登陆github,进入`fork`后的仓库,切换到新提交的`fixer`分支,点击右侧绿色按钮`Compare& pull request`
|
65 |
|
66 | ![pull](https://cloud.githubusercontent.com/assets/11772494/18979575/cde1bcf8-86fe-11e6-8ee2-51b7a1deb62b.png)
|
67 |
|
68 | 6. 添加注释信息,确认提交
|
69 |
|
70 | ![commit](https://cloud.githubusercontent.com/assets/11772494/18979581/d5e35fd8-86fe-11e6-9aae-d36c8f077ac8.png)
|
71 | |
\ | No newline at end of file |