| 1 | <?xml version="1.0" encoding="UTF-8"?> |
1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
2 | <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
| 3 | <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml,v 1.9 2007/02/14 21:30:15 nightmorph Exp $ --> |
3 | <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml,v 1.10 2007/04/01 10:35:45 nightmorph Exp $ --> |
| 4 | |
4 | |
| 5 | <guide link="/doc/en/bugzilla-howto.xml"> |
5 | <guide link="/doc/en/bugzilla-howto.xml"> |
| 6 | <title>Gentoo Bug Reporting Guide</title> |
6 | <title>Gentoo Bug Reporting Guide</title> |
| 7 | |
7 | |
| 8 | <author title="Author"> |
8 | <author title="Author"> |
| 9 | <mail link="chriswhite@gentoo.org">Chris White</mail> |
9 | <mail link="chriswhite@gentoo.org">Chris White</mail> |
| 10 | </author> |
10 | </author> |
| 11 | <author title="Editor"> |
11 | <author title="Editor"> |
| 12 | <mail link="fox2mike@gentoo.org">Shyam Mani</mail> |
12 | <mail link="fox2mike@gentoo.org">Shyam Mani</mail> |
| 13 | </author> |
13 | </author> |
| 14 | |
14 | |
| 15 | <abstract> |
15 | <abstract> |
| 16 | This document shows the proper method of reporting bugs using Bugzilla. |
16 | This document shows the proper method of reporting bugs using Bugzilla. |
| 17 | </abstract> |
17 | </abstract> |
| 18 | |
18 | |
| 19 | <!-- The content of this document is licensed under the CC-BY-SA license --> |
19 | <!-- The content of this document is licensed under the CC-BY-SA license --> |
| 20 | <!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
20 | <!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
| 21 | <license/> |
21 | <license/> |
| 22 | |
22 | |
| 23 | <version>1.8</version> |
23 | <version>1.9</version> |
| 24 | <date>2007-02-14</date> |
24 | <date>2007-04-01</date> |
| 25 | |
25 | |
| 26 | <chapter> |
26 | <chapter> |
| 27 | <title>Introduction</title> |
27 | <title>Introduction</title> |
| 28 | <section> |
28 | <section> |
| 29 | <title>Preface</title> |
29 | <title>Preface</title> |
| 30 | <body> |
30 | <body> |
| 31 | |
31 | |
| 32 | <p> |
32 | <p> |
| 33 | One of the factors that delay a bug being fixed is the way it is reported. By |
33 | One of the factors that delay a bug being fixed is the way it is reported. By |
| 34 | creating this guide, we hope to help improve the communication between |
34 | creating this guide, we hope to help improve the communication between |
| 35 | developers and users in bug resolution. Getting bugs fixed is an important, if |
35 | developers and users in bug resolution. Getting bugs fixed is an important, if |
| 36 | not crucial part of the quality assurance for any project and hopefully this |
36 | not crucial part of the quality assurance for any project and hopefully this |
| 37 | guide will help make that a success. |
37 | guide will help make that a success. |
| 38 | </p> |
38 | </p> |
| 39 | |
39 | |
| … | |
… | |
| 836 | <li>Product - Gentoo Linux (Since it is an ebuild issue)</li> |
836 | <li>Product - Gentoo Linux (Since it is an ebuild issue)</li> |
| 837 | <li>Component - Application (It is an application at fault, foobar2)</li> |
837 | <li>Component - Application (It is an application at fault, foobar2)</li> |
| 838 | <li>Hardware Platform - All (This error could occur across architectures)</li> |
838 | <li>Hardware Platform - All (This error could occur across architectures)</li> |
| 839 | <li>Operation System - All (It could occur on all types of systems)</li> |
839 | <li>Operation System - All (It could occur on all types of systems)</li> |
| 840 | </ul> |
840 | </ul> |
| 841 | |
841 | |
| 842 | <figure link="/images/docs/bugzie-basic-comp.png" caption="Completed Basic Information"/> |
842 | <figure link="/images/docs/bugzie-basic-comp.png" caption="Completed Basic Information"/> |
| 843 | |
843 | |
| 844 | <ul> |
844 | <ul> |
| 845 | <li> |
845 | <li> |
| 846 | Build Identifier is basically the User Agent of the browser that is being |
846 | Build Identifier is basically the User Agent of the browser that is being |
| 847 | used to report the bugs (for logging purposes). You can just leave this as |
847 | used to report the bugs (for logging purposes). You can just leave this as |
| 848 | is. |
848 | is. |
| 849 | </li> |
849 | </li> |
| 850 | <li> |
850 | <li> |
| 851 | URL is optional and is used to point to errors on a site someplace |
851 | URL is optional and is used to point to relevant information on another site |
| 852 | (pastebin, etc.). However, doing it inside the bug allows the developers be |
852 | (upstream bugzilla, release notes on package homepage etc.). You should |
| 853 | able to reference to it at any time and is preferred. |
853 | never use URL to point to pastebins for error messages, logs, <c>emerge |
|
|
854 | --info</c> output, screenshots or similar information. Instead, these should |
|
|
855 | always be attached to the bug. |
| 854 | </li> |
856 | </li> |
| 855 | <li> |
857 | <li> |
| 856 | In the Summary, you should put the package category, name, and number. |
858 | In the Summary, you should put the package category, name, and number. |
| 857 | </li> |
859 | </li> |
| 858 | </ul> |
860 | </ul> |
| 859 | |
861 | |
| 860 | <p> |
862 | <p> |
| 861 | Not including the category in the summary really isn't too bad, but it's |
863 | Not including the category in the summary really isn't too bad, but it's |
| 862 | recommended. If you don't include the package name, however, we won't know what |
864 | recommended. If you don't include the package name, however, we won't know what |
| 863 | you're filling a bug for, and will have to ask you about it later. The version |
865 | you're filling a bug for, and will have to ask you about it later. The version |
| 864 | number is important for people searching for bugs. If 20 people filed bugs and |
866 | number is important for people searching for bugs. If 20 people filed bugs and |
| 865 | not one put a version number, how would people looking for similar bugs be able |
867 | not one put a version number, how would people looking for similar bugs be able |
| 866 | to tell if one was there's? They'd have to look through every single bug, which |
868 | to tell if one was there's? They'd have to look through every single bug, which |
| 867 | isn't too hard, but if there are say, 200 bugs.. it's not that easy. After all |
869 | isn't too hard, but if there are say, 200 bugs.. it's not that easy. After all |
| 868 | the package information, you'll want to include a small description of the |
870 | the package information, you'll want to include a small description of the |