[
https://issues.apache.org/jira/browse/WEEX-86?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16209072#comment-16209072
]
ASF GitHub Bot commented on WEEX-86:
------------------------------------
Github user jondong commented on a diff in the pull request:
https://github.com/apache/incubator-weex-site/pull/2#discussion_r145360531
--- Diff: source/bug-report-guidelines.md ---
@@ -0,0 +1,66 @@
+---
+title: Bug Report Guidelines
+type: community
+has_chapter_content: false
+version: 2.1
+---
+
+# Bug Report Guidelines
+
+This document describes how to write a good Weex bug report. Good bug
reports help developers decide an appropriate priority and severity for a bug,
and increase the chance that a bug will be fixed quickly. The more specific
information you can provide, the better.
+
+## Bug Report General Principles
+
+- Avoid duplicates: Search before you file!
+- Always test the latest available version.
+- One bug per report.
+- State useful facts, not opinions or complaints.
+
+## How to Write a Good Bug Report
+
+A good bug report should include the following information:
+
+### Summary
+
+The goal of summary is to make the report searchable and uniquely
identifiable.
+
+A bad example: `List Crash`
+
+A good Example: `List Crashes when deleting a header`
+
+### Environment
+
+**Weex Version**: Please tell the version of WeexSDK or Weex Playground or
weex-toolkit you were using when the bug occurred
+
+**Device environment**: Please tell the device model, platform and OS
version that your bug occurred on. e.g. , iPhone 6, iOS 10.3.
+
+### Overview/Description
+
+The overview or description of a bug report is to explain the bug to the
developer, including:
+
+- Justifications of why this is a bug
+- [dotwe](http://dotwe.org/vue/) demo that can reproduce the bug
+- Screenshots for visual bugs
+- Stack traces for crash bugs
+- Console logs or error messages which are relevant in the bug
+
+### Steps to Reproduce
+
+The goal of reproducible steps is to teach developer to recreate the bug
on his own system, such as:
--- End diff --
The aim to provide the reproducible steps is to enable developers to
reproduce the bug in their own environment. Here's an example:
> Reorganize the structure of documents and website
> -------------------------------------------------
>
> Key: WEEX-86
> URL: https://issues.apache.org/jira/browse/WEEX-86
> Project: Weex
> Issue Type: Improvement
> Components: Project
> Reporter: Hanks Zhang
> Assignee: zhengshihan
>
> h1. Weex Document Index
> + contributing.md
> + development-process.md
> + who-is-using-weex.md
> + releasenote.md
> + resources.md
> h2. Guide
> + index.md
> + advanced
> + app-architecture.md
> + downgrade.md
> + page-architecture.md
> + path.md
> + use-vuex-and-vue-router.md
> + extend-android.md
> + extend-ios.md
> + extend-js-framework.md
> + extend-web-render.md
> + front-end-frameworks.md
> + integrate-devtool-to-android.md
> + integrate-devtool-to-ios.md
> + integrate-to-your-app.md
> + set-up-env.md
> + using-rax.md
> + using-vue.md
> h2. References
> + index.md
> + android-apis.md
> + ios-apis.md
> + js-framework-apis.md
> + js-service.md
> + weex-variable.md
> h3. Components
> + a.md
> + cell.md
> + div.md
> + image.md
> + indicator.md
> + input.md
> + list.md
> + loading.md
> + refresh.md
> + scroller.md
> + slider.md
> + switch.md
> + text.md
> + textarea.md
> + video.md
> + waterfall.md
> + web.md
> h3. Modules
> + animation.md
> + clipboard.md
> + dom.md
> + globalevent.md
> + meta.md
> + modal.md
> + navigator.md
> + picker.md
> + storage.md
> + stream.md
> + websocket.md
> + webview.md
> h2. WiKi
> + color-names.md
> + common-events.md
> + common-styles.md
> + css-units.md
> + design-principles.md
> + event-bubble.md
> + faq.md
> + gestures.md
> + index.md
> + platform-difference.md
> + text-styles.md
> h2. Tools
> + helpers.md
> + index.md
> + market.md
> + toolkit.md
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
