You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@weex.apache.org by cxfeng1 <gi...@git.apache.org> on 2017/10/18 08:59:56 UTC

[GitHub] incubator-weex-site pull request #2: [WEEX-86] Update documentation for cont...

GitHub user cxfeng1 opened a pull request:

    https://github.com/apache/incubator-weex-site/pull/2

    [WEEX-86] Update documentation for contribution.

    Separate contributing to several ways: reporting bugs, answering questions, joining in discussions, contributing documentation and contributing code.
    This will make it easier for developers who just want to report bugs,  and it will also make the contributing process progressive.
    Two additional documents are also added: Bug Report Guidelines and Development Process,  which provide more detail information about reporting bugs and contributing code.
    
    issue: 86

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/cxfeng1/incubator-weex-site doc-contributing

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/incubator-weex-site/pull/2.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #2
    
----
commit 92fd2b85a1bb2e0a7002083ea3308302d42b3a4b
Author: yinfeng <cx...@apache.org>
Date:   2017-10-18T08:58:01Z

    Update documentation for contribution.
    
    Separate contributing to several ways: reporting bugs, answering questions, joining in discussions, contributing documentation and contributing code.
    This will make it easier for developers who just want to report bugs,  and it will also make the contributing process progressive.
    Two additional documents are also added: Bug Report Guidelines and Development Process,  which provide more detail information about reporting bug and contributing code.
    
    issue: 86

----


---

[GitHub] incubator-weex-site issue #2: [WEEX-86] Update documentation for contributio...

Posted by Hanks10100 <gi...@git.apache.org>.

Github user Hanks10100 commented on the issue:

    https://github.com/apache/incubator-weex-site/pull/2
  
    This PR is already merged into master.


---

[GitHub] incubator-weex-site pull request #2: [WEEX-86] Update documentation for cont...

Posted by jondong <gi...@git.apache.org>.

Github user jondong commented on a diff in the pull request:

https://github.com/apache/incubator-weex-site/pull/2#discussion_r145361914

--- 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:
+
+*Step 1: Load the demo using Weex Playground*
+
+*Step 2: Scroll to the bottom of the list*
+
+*Step 3: Click the red button to delete a header*
+
+### Test Results
+
+The test results, including *Expected Result* and *Actual Result*, will show the developer what's wrong. *Expected Result* describes what should have happened, and *Actual Result* describes what actually happened.
--- End diff --

will tell developers what's wrong.

---

[GitHub] incubator-weex-site pull request #2: [WEEX-86] Update documentation for cont...

Posted by jondong <gi...@git.apache.org>.

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:


---

[GitHub] incubator-weex-site pull request #2: [WEEX-86] Update documentation for cont...

Posted by jondong <gi...@git.apache.org>.

Github user jondong commented on a diff in the pull request:

    https://github.com/apache/incubator-weex-site/pull/2#discussion_r147055981
  
    --- Diff: source/bug-report-guidelines.md ---
    @@ -56,7 +56,7 @@ The goal of reproducible steps is to teach developer to recreate the bug on his
     
     ### Test Results
     
    -The test results, including *Expected Result* and *Actual Result*, will show the developer what's wrong. *Expected Result* describes what should have happened, and *Actual Result* describes what actually happened.
    +The test results, including *Expected Result* and *Actual Result*, will tell developers what's wrong. *Expected Result* describes what should have happened, and *Actual Result* describes what actually happened.
    --- End diff --
    
    what should happen, & what actually happens.
    I think we are describing the common fact, it is better to use the present tense.


---

[GitHub] incubator-weex-site pull request #2: [WEEX-86] Update documentation for cont...

Posted by jondong <gi...@git.apache.org>.

Github user jondong commented on a diff in the pull request:

https://github.com/apache/incubator-weex-site/pull/2#discussion_r145359205

is to explain the bug in detail.
remove "to the developer"

---

[GitHub] incubator-weex-site pull request #2: [WEEX-86] Update documentation for cont...

Posted by jondong <gi...@git.apache.org>.

Github user jondong commented on a diff in the pull request:

    https://github.com/apache/incubator-weex-site/pull/2#discussion_r147056066
  
    --- Diff: source/bug-report-guidelines.md ---
    @@ -7,12 +7,12 @@ 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.
    +This document describes how to write a good Weex bug report. Good bug reports help developers classify the priority and severity of a bug properly, which helps the bug get fixed as soon as possible. The more specific information you provide, the better your bug gets understood.
    --- End diff --
    
    to classify


---

[GitHub] incubator-weex-site pull request #2: [WEEX-86] Update documentation for cont...

Posted by jondong <gi...@git.apache.org>.

Github user jondong commented on a diff in the pull request:

    https://github.com/apache/incubator-weex-site/pull/2#discussion_r145356624
  
    --- 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
    --- End diff --
    
    is it better to use title here? not quite sure


---

[GitHub] incubator-weex-site pull request #2: [WEEX-86] Update documentation for cont...

Posted by cxfeng1 <gi...@git.apache.org>.

Github user cxfeng1 closed the pull request at:

    https://github.com/apache/incubator-weex-site/pull/2


---

[GitHub] incubator-weex-site pull request #2: [WEEX-86] Update documentation for cont...

Posted by jondong <gi...@git.apache.org>.

Github user jondong commented on a diff in the pull request:

    https://github.com/apache/incubator-weex-site/pull/2#discussion_r145355536
  
    --- 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.
    --- End diff --
    
    to classify the priority and severity of a bug properly, which helps the bug get fixed as soon as possible. The more specific information you provide, the better your bug gets understood.


---

[GitHub] incubator-weex-site pull request #2: [WEEX-86] Update documentation for cont...

Posted by jondong <gi...@git.apache.org>.

Github user jondong commented on a diff in the pull request:

    https://github.com/apache/incubator-weex-site/pull/2#discussion_r145356107
  
    --- 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.
    --- End diff --
    
    before submitting a bug


---

[GitHub] incubator-weex-site pull request #2: [WEEX-86] Update documentation for cont...

Posted by jondong <gi...@git.apache.org>.

Github user jondong commented on a diff in the pull request:

    https://github.com/apache/incubator-weex-site/pull/2#discussion_r145356808
  
    --- 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
    --- End diff --
    
    please identify...


---

[GitHub] incubator-weex-site pull request #2: [WEEX-86] Update documentation for cont...

Posted by jondong <gi...@git.apache.org>.

Github user jondong commented on a diff in the pull request:

https://github.com/apache/incubator-weex-site/pull/2#discussion_r145357100

identify.
remove "that your bug occurred on"

---

[GitHub] incubator-weex-site pull request #2: [WEEX-86] Update documentation for cont...

Posted by jondong <gi...@git.apache.org>.

Github user jondong commented on a diff in the pull request:

    https://github.com/apache/incubator-weex-site/pull/2#discussion_r145356025
  
    --- 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!
    --- End diff --
    
    before you file a new one.


---