提交 6d5ff09a 编写于 作者: M Minwe

update feedback related docs

上级 86d27a7b
......@@ -13,7 +13,7 @@
## Bug 反馈
- 查看 [Issue
系统](https://github.com/allmobilize/amazeui/issues) 或者相关评论,确认 Bug
系统](https://github.com/allmobilize/amazeui/issues/new?title=Bug%3A%20&body=**%E9%97%AE%E9%A2%98%E6%8F%8F%E8%BF%B0**%0A%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**%E4%BA%A7%E7%94%9F%E7%8E%AF%E5%A2%83**%0A%0A-%20%E6%93%8D%E4%BD%9C%E7%B3%BB%E7%BB%9F%E5%8F%8A%E7%89%88%E6%9C%AC%EF%BC%9A%0A-%20%E6%B5%8F%E8%A7%88%E5%99%A8%E5%8F%8A%E7%89%88%E6%9C%AC%EF%BC%9A%0A-%20%E6%BC%94%E7%A4%BA%E5%9C%B0%E5%9D%80%EF%BC%9A%0A%0A**%E5%A4%8D%E7%8E%B0%E6%AD%A5%E5%A5%8F**%0A%0A1.%20%0A2.%20%0A...) 或者相关评论,确认 Bug
是否已经有人提交过,如果有,请直接在回复以前的反馈者;
- 确认 Bug 是否已经被修复;
- 隔离使用场景,确认 Bug 是否由第三方文件导致;
......@@ -21,6 +21,26 @@
- 如有可能尽量添加截图;
- 尽量添加可以在线查看的演示页面,推荐使用 JSBin 等工具。
**Bug 反馈模板**[点击使用模板](https://github.com/allmobilize/amazeui/issues/new?title=Bug%3A%20&body=**%E9%97%AE%E9%A2%98%E6%8F%8F%E8%BF%B0**%0A%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**%E4%BA%A7%E7%94%9F%E7%8E%AF%E5%A2%83**%0A%0A-%20%E6%93%8D%E4%BD%9C%E7%B3%BB%E7%BB%9F%E5%8F%8A%E7%89%88%E6%9C%AC%EF%BC%9A%0A-%20%E6%B5%8F%E8%A7%88%E5%99%A8%E5%8F%8A%E7%89%88%E6%9C%AC%EF%BC%9A%0A-%20%E6%BC%94%E7%A4%BA%E5%9C%B0%E5%9D%80%EF%BC%9A%0A%0A**%E5%A4%8D%E7%8E%B0%E6%AD%A5%E5%A5%8F**%0A%0A1.%20%0A2.%20%0A...)
```
**问题描述**
(描述一下问题)
**产生环境**
- 操作系统及版本:
- 浏览器及版本:
- 演示地址:
**复现步奏**
1.
2.
...
```
## 功能需求
欢迎提交功能需求。不过提交之前先看看以下几点:
......@@ -40,8 +60,10 @@ Pull Request 之前,请先阅读 [Amaze UI 编码规范](https://github.com/al
## 我们希望用户参与的项目
- 把使用 Amaze UI 的项目提交给我们,能获得一定的展示量,同时能给其他用户提供参考;
- SCSS 等其他 CSS 扩展语言的支持:通过编写自动转换脚本实现,人工迁移同步更新成本太高;
- 使用 Amaze UI 开发制作模板;
- Angular.js、Ember.js 等框架的支持;
- 基于 Amaze UI 样式开发 JavaScript 插件;
- Angular.js、Ember.js、Meteor 等框架的支持;
- 基于 Amaze UI 样式开发 JavaScript 插件,可以把 Bootstrap 的插件移植到 Amaze UI;
- 兼容性测试,我们的测试只能覆盖有限,需要更多用户参与,包括浏览器、WebView 等不同的用户代理;
- ...
......@@ -92,7 +92,7 @@ gulp
### Bug 反馈
欢迎给 Amaze UI [提交 Bug](https://github.com/allmobilize/amazeui/issues)
欢迎给 Amaze UI [提交 Bug](https://github.com/allmobilize/amazeui/issues/new?title=Bug%3A%20&body=**%E9%97%AE%E9%A2%98%E6%8F%8F%E8%BF%B0**%0A%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**%E4%BA%A7%E7%94%9F%E7%8E%AF%E5%A2%83**%0A%0A-%20%E6%93%8D%E4%BD%9C%E7%B3%BB%E7%BB%9F%E5%8F%8A%E7%89%88%E6%9C%AC%EF%BC%9A%0A-%20%E6%B5%8F%E8%A7%88%E5%99%A8%E5%8F%8A%E7%89%88%E6%9C%AC%EF%BC%9A%0A-%20%E6%BC%94%E7%A4%BA%E5%9C%B0%E5%9D%80%EF%BC%9A%0A%0A**%E5%A4%8D%E7%8E%B0%E6%AD%A5%E5%A5%8F**%0A%0A1.%20%0A2.%20%0A...)
为了能最准确的传达所描述的问题, 建议你在反馈时附上演示,方便我们理解。
......@@ -117,9 +117,19 @@ gulp
- [The Beginner’s Guide to Contributing to Open Source Projects](http://blog.newrelic.com/2014/05/05/open-source_gettingstarted/)
- [How to Start Contributing to Open Source](http://www.developer.com/open/how-to-start-contributing-to-open-source.html)
__开发文档__
### 我们希望用户参与的项目
开发文档存放在 `docs/rules` 目录下,也可以通过 [Amaze UI 官网](http://amazeui.org/)查看:
- 把使用 Amaze UI 的项目提交给我们,能获得一定的展示量,同时能给其他用户提供参考;
- SCSS 等其他 CSS 扩展语言的支持:通过编写自动转换脚本实现,人工迁移同步更新成本太高;
- 使用 Amaze UI 开发制作模板;
- Angular.js、Ember.js、Meteor 等框架的支持;
- 基于 Amaze UI 样式开发 JavaScript 插件,可以把 Bootstrap 的插件移植到 Amaze UI;
- 兼容性测试,我们的测试只能覆盖有限,需要更多用户参与,包括浏览器、WebView 等不同的用户代理;
- ...
### 开发文档
开发文档存放在 `docs/styleguide` 目录下,也可以通过 [Amaze UI 官网](http://amazeui.org/)查看:
- [Amaze UI HTML/CSS 编写规范](http://amazeui.org/getting-started/html-css)
- [Amaze UI JavaScript 编写规范](http://amazeui.org/getting-started/javascript)
......@@ -155,3 +165,9 @@ License](https://github.com/sindresorhus/screenfull.js/blob/gh-pages/license))
* [FlexSlider](https://github.com/woothemes/FlexSlider) ([GPL 2.0](http://www.gnu.org/licenses/gpl-2.0.html))
可能会有部分项目遗漏,我们会不断整理更新。
## Developed with [WebStorm](http://www.jetbrains.com/webstorm/) Open Source Licensed version
<a href="http://www.jetbrains.com/webstorm/" target="_blank">
<img src="http://ww1.sinaimg.cn/large/005yyi5Jjw1elpp6svs2eg30k004i3ye.gif" width="240" />
</a>
......@@ -138,3 +138,9 @@ License](https://github.com/sindresorhus/screenfull.js/blob/gh-pages/license))
* [FlexSlider](https://github.com/woothemes/FlexSlider) ([GPL 2.0](http://www.gnu.org/licenses/gpl-2.0.html))
There might be some missing and we will keep updating.
## Developed with [WebStorm](http://www.jetbrains.com/webstorm/) Open Source Licensed version
<a href="http://www.jetbrains.com/webstorm/" target="_blank">
<img src="http://ww1.sinaimg.cn/large/005yyi5Jjw1elpp6svs2eg30k004i3ye.gif" width="240" />
</a>
......@@ -4,15 +4,54 @@
感谢对 Amaze UI 的关注和支持,如遇到 Bug 或者使用问题,可以通过以下途径反馈给我们:
- 在文档底部[评论中留言](#ds-thread)
- 在 GitHub 项目主页[提交 Issue](https://github.com/allmobilize/amazeui/issues)
- 在 GitHub 项目主页[提交 Issue](https://github.com/allmobilize/amazeui/issues/new?title=Bug%3A%20&body=**%E9%97%AE%E9%A2%98%E6%8F%8F%E8%BF%B0**%0A%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**%E4%BA%A7%E7%94%9F%E7%8E%AF%E5%A2%83**%0A%0A-%20%E6%93%8D%E4%BD%9C%E7%B3%BB%E7%BB%9F%E5%8F%8A%E7%89%88%E6%9C%AC%EF%BC%9A%0A-%20%E6%B5%8F%E8%A7%88%E5%99%A8%E5%8F%8A%E7%89%88%E6%9C%AC%EF%BC%9A%0A-%20%E6%BC%94%E7%A4%BA%E5%9C%B0%E5%9D%80%EF%BC%9A%0A%0A**%E5%A4%8D%E7%8E%B0%E6%AD%A5%E5%A5%8F**%0A%0A1.%20%0A2.%20%0A...)
## Bug 反馈要求
- 标题:简要描述 Bug;
- 内容:
- 描述一下 Bug,以及 Bug 产生的环境(操作系统及版本,浏览器以及版本);
- 如有可能,描述 Bug 复现的流程;
- 如有可能,添加产生 Bug 时的截图;
- 尽量添加 Bug 测试的 URL,推荐使用 [JSBin](http://jsbin.com/?html,output)
```
**问题描述**
(描述一下问题)
**产生环境**
- 操作系统及版本:
- 浏览器及版本:
- 演示地址:
**复现步奏**
1.
2.
...
```
<!--
https://github.com/allmobilize/amazeui/issues/new?title=Bug%3A%20&body=**问题描述**%0A%0A(描述一下问题)%0A%0A**产生环境**%0A%0A- 操作系统及版本:%0A- 浏览器及版本:%0A- 演示地址:%0A%0A**复现步奏**%0A%0A1. %0A2. %0A...-->
## 注意事项
__提交反馈__
为了能最准确的传达所描述的问题, __建议你在反馈时附上演示__,方便我们理解。
为了能最准确的传达所描述的问题,__建议你在反馈时附上演示__,方便我们理解及更快速的定位、解决问题。
我们很不喜欢重复对话:
```
用户甲:xxx 有问题?
下面的几个链接是我们在几个在线调试工具上建的页面, __已经引入了 Amaze UI 样式和脚本__,你可以选择你喜欢的工具<span class="am-text-danger">【Fork】</span>一份, 把要有问题的场景粘在里面,反馈给我们。
Amaze UI:什么问题?操作系统及版本、浏览器及版本?
用户甲:巴拉巴拉
```
下面的几个链接是我们在几个在线调试工具上建的页面,__已经引入了 Amaze UI 样式和脚本__,你可以选择你喜欢的工具<span class="am-text-danger">【Fork】</span>一份, 把要有问题的场景粘在里面,反馈给我们。
- [JSBin](http://jsbin.com/kijiqu/1/edit?html,output)
- [JSFiddle](http://jsfiddle.net/hegfirose/W22fV/)
......@@ -23,4 +62,21 @@ __反馈处理__:
提交到 GitHub 的 Issue 一般会通过两种方式关闭:
- __涉及代码修改的问题__:一般会通过 Commit 关闭 Issue,在收到关闭通知以后你可以更新代码确认问题是否已经被修复。如果问题依然存在,劳烦 Reopen Issue 并把问题细节提交给我们;
- __使用问题__:在我们给出答案后,希望你能反馈一下是否解决了你的问题。如果解决了,请关闭 Issue;如果未解决,请描述具体细节。如给出答案一周后仍无任何回复的,Issue 将被关闭。
\ No newline at end of file
- __使用问题__:在我们给出答案后,希望你能反馈一下是否解决了你的问题。如果解决了,请关闭 Issue;如果未解决,请描述具体细节。如给出答案一周后仍无任何回复的,Issue 将被关闭。
## 常见问题
### 支持贴图吗?
GitHub Issue 系统支持贴图,把**图片拖到输入框**里图片会自动上传并插入到内容中,也可以**直接复制粘贴图片**
多说评论系统见下面。
### 如何在多说评论框里面贴图?
多说评论系统的贴图功能已经开启,但是多说并没有提供图片服务器,仍然需要通过第三方图床来完成。
点击**图片**图标以后,把 `请输入图片地址` 替换成图床里的图片地址。
- [Gimhoy图床](http://pic.gimhoy.com/)
- [围脖图床修复计划(浏览器插件)](http://weibotuchuang.sinaapp.com/)
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册