Bug 7876

Summary:	Proposal for enhancing the bug reporting
Product:	[Infrastructure] Bugzilla	Reporter:	Igor Stoppa <igor.stoppa>
Component:	bugzilla	Assignee:	Michael Halstead <mhalstead>
Status:	RESOLVED FIXED	QA Contact:
Severity:	enhancement
Priority:	Low	CC:	infras.bug.watcher, Infras.watcher, sgw
Version:	unspecified
Target Milestone:	Future
Hardware:	x86
OS:	Multiple
Whiteboard:
OS type for building Yocto:	---	Type of Regression:	---
Verified:		Documentation change:	Don't know

Description Igor Stoppa 2015-06-11 08:45:06 UTC

If possible (AFAIK it was, in other instances of bugzilla I have used in the past), I would propose to add a template for the reporting of an issue.

Something like:


Preconditions/Environment
-------------------------

List here what is the setup used.



Triggering Action/Cause
-----------------------

What how to make the phenomenon to happen.



Expectation
-----------

What should happen.



Actual Result
-------------

What really happens



Reproducibility
---------------

m/n

Where:
n = total number of attempts
m = number of times the phenomenon is visible


This template is more focused on reporting issues than requesting new features, but it could be adjusted to cover both.
Or maybe 2 different templates would be given to the user, then the one that is not needed could be removed by the user.

Comment 1 Michael Halstead 2015-06-12 15:09:16 UTC

It should be trivial to add this default text to the description field of all new bugs in the enter_bug.cgi script. This would require people to select all and delete if they didn't want to follow the template. Shall I add it?

Comment 2 Saul Wold 2015-06-18 22:33:02 UTC

We are going to add a link in the Bugzilla New Bug page to a wiki page that will contain this template along with other information about providing a good bug description.  

This will allow for multiple templates that can be cut/pasted and more details without cluttering bugzilla's description area.

Comment 3 Michael Halstead 2015-06-18 23:03:58 UTC

The current text is:

Please review the Bugzilla Guidelines and use a New Bug Template to ensure you include all needed information. 

Visible at https://bugzilla.yoctoproject.org/enter_bug.cgi?product=OE-Core

Comment 4 Michael Halstead 2015-06-22 22:40:43 UTC

Updated to "Before posting a bug, please review the Yocto Project Bugzilla Guidelines wiki, the wiki also contains some Bugzilla Description Templates to help ensure a complete bug report or enhancement request is made."

I think this will work. Please update the https://wiki.yoctoproject.org/wiki/Bugzilla_Templates#Bugzilla_Templates as needed.