This document provides guidelines for writing effective feature requests and bug reports. It distinguishes between bugs and features, and offers tips for writing concise user stories, use cases and steps to reproduce issues. Examples of good and bad summaries are given. Links to additional bug and feature reporting resources are included.

1. Iris
2014/07/18

2. OUTLINE
Difference between bug and feature
How to write feature requests
Tips
Examples
How to write bug reports
Tips
Examples

3. Differencebetween bug and feature
Obvious bugs :
Ex: crash, hang, hardware fault, exception.
I think this is a bug... :
Communicate !

4. How to write a feature request
One at a time.
Be concise.
Think about:
what type of user would use this new feature?
How many people would use it?
Include a picture if it’s necessary.

5. Feature request examples

6. Feature request examples

7. Feature request examples

8. Feature request examples
Include:
1.User story or Summary
2.Current version
3.Why we need this feature?
4.Use cases
5.Expected outcomes

9. How to write a bug report
Avoid duplicates.
Include pictures.
Don’t use personal judgment.
Ex: I don’t think that the home page UI design is nice.

10. How to write a bug report
Summary:
Good: "Selecting Gender is not functional."
Bad: "Software crashes."

11. Bug report examples

12. Bug report examples

13. Bug report examples
Steps to Reproduce:

14. Bug report examples
ExpectedResults:
Actual Results:

16. http://incredibots.sourceforge.net/reportbug.html
http://blogs.msdn.com/b/tdragger/archive/2006/01/23/516681.aspx
http://www.mediawiki.org/wiki/How_to_report_a_bug
http://wiki.xbmc.org/index.php?title=HOW- TO:Submit_a_bug_report
https://github.com/rauhryan/huboard/issues/208