Changes

Jump to navigation Jump to search

Bugzilla Help (view source)

Revision as of 12:06, 12 February 2015

5,641 bytes added ,  12:06, 12 February 2015
→‎Verifying Bugs
Line 1: Line 1:  +
<noinclude>{{Languages}}</noinclude>
 
==Bug Tracker==
 
==Bug Tracker==
 +
 +
Please help us to make our software as reliable as possible. Please report possible bugs only via the bug tracker and encourage others to do the same.
 +
 +
Bugzilla is just a standard communication format for problem solving. Replies may seem abrupt but that is just the nature of the medium. Don't be concerned by a stark Wontfix or Invalid, it's how the system works. Discussions are for forums
 +
 
Find, report and fix bugs here http://bugs.contribs.org
 
Find, report and fix bugs here http://bugs.contribs.org
   −
As SME Server is based on Centos you may also be asked to vist [http://bugs.centos.org/main_page.php bugs.centos.org]
+
===Bugzilla is easy===
 +
 
 +
A frequent complaint is Bugzilla is too hard or convoluted, but it is hard to justify the complaint.
 +
 
 +
*You open an account
 +
*Then report your problem
 +
 
 +
SME is run by volunteers so we expect you to help by searching for existing bugs and by filing your bug in the format described below. To begin you need only read 'searching' and 'reporting'.
 +
 
 +
===Searching Bugs===
 +
 
 +
Have you searched bugzilla, and read the SME Server Manual and FAQ ?
 +
 
 +
Simple and Advanced aren't necessarily easy so we added prepared searches to the bugzilla page headers.
 +
 
 +
* Simple
 +
Select a Status and a Product category and enter your search term
 +
 
 +
* Advanced
 +
You can restrict searches by using a selection or multiple selections of a category  <br />
 +
Use Control Click to select/deselect from selection sets, if none are selected the defailt is all.
 +
 
 +
* Reports
 +
A wiki page with more prepared searches.
 +
 
 +
* Matrix
 +
A Grid with one view of current bugs, more are available in Reports.
 +
 
 +
* Recent
 +
Bugs with activity in the last two days
 +
 
 +
===Reporting Bugs===
 +
 
 +
Please take the time to read
 +
[http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to report bugs effectively]
 +
(available in multiple languages)
 +
 
 +
For bugs in SME Server Release, SME Server Future & SME Server Translations the following format is suggested. It's not always appropriate so use some discretion, see eg. New Feature Requests
   −
You don't have to be a programmer to help or use the bug tracker.
+
When reporting a new bug, and after choosing the platform, the next screen asks for more details on your problem.  There are 4 main fields that need to be completed. These are '''Component,''' '''Found-In-Version,''' '''Summary,''' and '''Description.'''  Fields such as '''Flags''' and '''Requestee''' should be left blank initially by most reporters. The '''CC''' field is for other people you would like notices on this issue to be sent to. YOU will always be automatically included by default, so you don't need to 'cc' yourself.  The '''Attachment''' button at the bottom of the page is used to attach additional file information such as log files that may be helpful.
−
Bugs also include fixing and making suggestions on documentation, translations and the SME Server web sites.
     −
===Bug Categories===
+
'''Component:''' As accurately as possible, you may choose which category your issue fits into.  If Unknown then choose UNKNOWN.
−
Bugs are sorted by '''Product''', they should be mostly self explanatory. Future/7.x/8.x may need clarifying.  
     −
With the release of SME 7.3, development is now focussed on reaching 8.0
+
'''Found-in-version:''' Usually self explanatory.  If it applies to more than one version, choose the most recent stable release.
   −
  SME Server Future       
+
'''Summary:''' How would you describe the bug. BE BRIEF. A good summary should quickly and uniquely identify a bug report. It should explain the problem, not your suggested solution.
−
  Bugs can be moved to future if they can be classified as NewFeatureRequest,
+
 
−
  or as cleanup functionality that does not have a major (user-visible) impact.
+
* Good: "Canceling a File Copy dialog crashes File Manager"
−
  Bugs that should be fixed, but not sure which future release they will be fixed in
+
* Bad: "Software crashes"
 +
* Bad: "Browser should work with my web site"
 +
 
 +
'''Description:''' Present the details of your problem in this section.  You may use the following as a template:
 +
'''ENVIRONMENT''':    '''''Give a brief server history'''''
 +
   
 +
eg. SME Server 7.1, Updated to 7.3 with yum
 +
 +
'''MODIFICATIONS''':  '''''List any contribs or modifications you have on the server'''''
 +
 +
eg. If the following produce any output, attach the results (don't post inline)
 +
    /sbin/e-smith/audittools/templates
 +
    /sbin/e-smith/audittools/newrpms
 +
 +
'''''or say''''', no custom-templates or contribs.
 +
 +
'''ORIGINAL PROBLEM''':  '''''State what you were trying to do.'''''
 +
 
 +
'''STEPS TO REPRODUCE''': '''''As accurately and exactly as possible state what you did to get your problem.'''''
 
   
 
   
−
  SME Server Release 7.X   
+
  '''ACTUAL RESULTS''':    '''''List what you got as a result.'''''
−
  The error is severe enough that we need to fix it, taking time away from 8.x development
  −
  The bug is being worked on actively
  −
  The bug has been cloned from 8.x for backporting
   
   
 
   
−
  SME Server Release 8.X
+
  '''EXPECTED RESULTS''':  '''''List what you expected to happen.'''''
−
  current development
+
 
 +
'''Attachment:'''  This is used to attach (not post in line) any logs or results of command line queries such as the examples listed in "Modifications" above.
   −
===Searching for bugs===
+
Finally, when satisfied with your entries, submit your bug report by pressing the '''COMMIT''' button.
−
To help find bugs, some prepared searches have been added in the page headers.
     −
1. More Prepared searchs in [[:Bugzilla Reports | Bugzilla Reports]]
+
===Verifying Bugs===
 +
Bugs in the SME Server Release, SME Contribs & SME Server Translations products
 +
need to be verified when fixed, see the [[Verification_Queue]] for the current list. See [[SME_Server:Documentation:QA:Verification]] for a detailed description of the verification process. <br />
 +
 
 +
An example is [[bugzilla:3727]] or [[bugzilla:7364]].
   −
2. Simple search <br />
+
'''Information from here is used in the Updates Announcements and if you use this format, it will save duplication of work'''
−
At the top of the search page choose 'Find a specific bug' <br />
  −
Select a Status and a Product category and enter your search term <br />
     −
3. Advanced search <br />
+
Other Products can be Closed after being fixed, as they are not part of the updates process.
−
At the top of the search page choose 'Advanced search'
     −
You can restrict searches by using a selection or multiple selections of a category <br />
+
The bug report will detail the exact package and version needed. These are normally in smeupdates-testing and can be installed by :
−
Use Control Click to select/deselect from selection sets, if none are selected all are.
+
yum --enablerepo=smeupdates-testing update <package>
 +
 
 +
for example
 +
yum --enablerepo=smeupdates-testing update e-smith-ldap
 +
 
 +
As it is a manual step to move packages into smeupdates-testing the most recent packages will be in smetest and can be installed from there if necessary.
 +
for example
 +
  yum --enablerepo=smetest update e-smith-ldap
 +
or if you need several repositories :
 +
  yum --enablerepo=smetest,smeupdates-testing,smedev update e-smith-ldap
 +
 
 +
When performing verification, please use the following template:
 +
 
 +
'''VERIFICATION TEMPLATE'''
 +
 
 +
= ENVIRONMENT:
 +
 +
= ORIGINAL PROBLEM:
 +
 +
= RESOLUTION:
 +
 +
= CURRENT VERSION INSTALLED:
 +
 +
= TESTING:
 +
 +
= UPDATED VERSION INSTALLED:
 +
 +
= PROBLEM FIXED:
 +
 +
= VERIFIED OR REOPEN:
 +
 +
= DOCUMENTATION IMPACT:
 +
 +
= SUGGESTED RELEASE NOTES:
 +
 
 +
AS AN EXAMPLE:
 +
 
 +
VERIFICATION
 +
 +
= ENVIRONMENT:
 +
[description of test system (version, installation methods, upgrade history. etc).
 +
If you have some non-core package installed, run /sbin/e-smith/audittools/newrpms and provide output]
 +
 +
= ORIGINAL PROBLEM:
 +
[Summarise bug]
 +
 +
= RESOLUTION:
 +
[Insert changelog for new package]
 +
In example:
 +
Fixed in e-smith-base
 +
* Mon Apr 21 2013 chris burnat <devlist@burnat.com> 5.4.0-27.sme
 +
- Fix the way '.' works in bash [SME: 7532]
 +
 +
= CURRENT VERSION INSTALLED:
 +
[rpm -qa <package name>]
 +
 +
=TESTING:
 +
[Reproduce bug if you can, showing steps taken]
 +
 +
= UPDATED VERSION INSTALLED:
 +
[Update to new package, show steps taken]
 +
and:
 +
  [rpm -qa <package name>]
 +
 +
= PROBLEM FIXED?:
 +
[Repeat steps carried out under TESTING above.
 +
 +
= VERIFIED OR REOPEN:
 +
[Problem fixed, then VERIFIED - not fixed, then REOPEN]
 +
Note: if you may not have rights to toggle resolution, someone will do it for you
 +
 +
= DOCUMENTATION IMPACT:
 +
[Does something need documentation, eg a db or new procedure? if affirmative, please provide details, someone will later punt to docteam for action]
 +
 +
= SUGGESTED RELEASE NOTES:
 +
[Summary of what was fixed]
 +
 
 +
===Testing===
 +
It is recommended that some basic tests be carried out before resolving VERIFIED. The scope of these tests very much depends on functionality associated with the package(s) under consideration. The following list whilst not fully inclusive can be used as a guide:
 +
 
 +
*Hosting http
 +
*Hosting https
 +
*Access external http
 +
*Access external https
 +
*SSH access to server
 +
*Send Email
 +
*Receive Email
 +
*Use Webmail
 +
*Use Samba
 +
*FTP access to SME
 +
*Check /var/log/messages or/and any other relevant log.
 +
 
 +
===General===
 +
====Bug Categories====
 +
 
 +
Bugs are sorted by '''Product''', they should be mostly self explanatory. Future/7.x/8.x/9.x may need  clarifying.
 +
 
 +
With the release of SME 8.0, development is now focussed on reaching 9.0
 +
 
 +
*SME Server Future       
 +
-  Bugs can be moved to future if they can be classified as NewFeatureRequest
   −
===Reporting Bugs===
+
-  or as cleanup functionality that does not have a major (user-visible) impact.
−
Please help us to make our software as reliable as possible. Your role in that is to report possible bugs only via the bug tracker, and to encourage others to do the same.  
     −
Everyone reporting bugs needs to read:
+
-  Bugs that should be fixed, but not sure which future release they will be fixed in
−
[http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to report bugs effectively]
+
 +
*SME Server Release 7.X   
 +
-  The error is severe enough that we need to fix it, taking time away from 9.x development
   −
Also see [http://www.bugzilla.org/docs/tip/html/using.html General Instructions] ,
+
-  The bug is being worked on actively
−
[http://www.bugzilla.org/docs/tip/html/bugreports.html#fillingbugs Reporting a New Bug]
  −
and [http://bugs.contribs.org/page.cgi?id=bug-writing.html Bug Writing]
     −
If you have searched the Wiki, Forum and Bug Tracker and not found an answer or someone else's report that matches yours, you should register on the Bug Tracker and enter a new bug. The debugging process of any issue requires active participation on the part of the reporter, providing further information and clarification of the problem.
+
-  The bug has been cloned from 8.x for backporting
   −
Anyone reporting problems, ask yourself these important questions, so that you know what to tell the developers in the bug report:
+
*SME Server Release 8.X   
 +
-  The error is severe enough that we need to fix it, taking time away from 9.x development
   −
* What version am I using and are there any contribs installed or other customisations?
+
-  The bug is being worked on actively
−
* What did I do?
  −
* What did I expect to happen?
  −
* What happened?
  −
* What do the logs say?
     −
===Working on Bugs===
+
*SME Server Release 9.X
−
Find a bug where you understand the problem
+
-  current development
−
* confirm there is a problem see [[:Bugzilla_Help#Bug_Triage| Bug Triage]]
  −
* find or confirm a fix
  −
* post brief details of confirmation, how to fix or how you verified
  −
* then change the Status
      
====Bug Triage====
 
====Bug Triage====
−
If you can help do these steps, the developers can concentrate on fixing the bugs. <br >
+
 
−
The steps in this list is maybe 90% of the time of most bugs.  
+
If you can help, the developers can concentrate on fixing the bugs. <br >
 +
The steps in this list take approx 90% of the time in the resolving of most bugs.  
    
Reread [http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to report bugs effectively]
 
Reread [http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to report bugs effectively]
Line 75: Line 225:  
Now look at the bug reports in Bugzilla with your developer hat on.
 
Now look at the bug reports in Bugzilla with your developer hat on.
   −
* Go into triage mode
+
* Go into triage mode this page can help You : [[Bugzilla_Reports]]
 
* Ask the questions asked by the essay
 
* Ask the questions asked by the essay
 
* Get the information from the reporter
 
* Get the information from the reporter
Line 85: Line 235:     
====Bug Status====
 
====Bug Status====
 +
 
[http://www.bugzilla.org/docs/tip/html/lifecycle.html Lifecycle of a Bug]
 
[http://www.bugzilla.org/docs/tip/html/lifecycle.html Lifecycle of a Bug]
   Line 93: Line 244:  
Note. Project Developers tend not to look at unconfirmed bugs as they only have so much time, so it's important regular users check each others bugs.
 
Note. Project Developers tend not to look at unconfirmed bugs as they only have so much time, so it's important regular users check each others bugs.
   −
* NEW
+
* NEEDINFO
−
Once bugs are confirmed, '''by anyone''' see note above, change the status to new,
+
This is a new state that should be used when more information is needed by the bug reporter.
 +
 
 +
* CONFIRMED
 +
Once bugs are confirmed to be valid and present in SME Server, '''by anyone''' see note above, change the status to CONFIRMED.
 +
Only change to CONFIRMED if the bug is well written and has enough information to proceed.
 +
 
 +
* IN_PROGRESS
 +
This indicates a developer is actively working on the bug.
   −
----
   
* FIXED
 
* FIXED
 
Set to fixed after the problem has been solved for others,  
 
Set to fixed after the problem has been solved for others,  
Line 114: Line 271:  
Alternatives to Fixed are :
 
Alternatives to Fixed are :
   −
* INVALID
+
* NOTABUG
 
If you see that a problem is not a bug. eg User error
 
If you see that a problem is not a bug. eg User error
 
Mark INVALID if the report is of documented (i.e. expected and correct)  
 
Mark INVALID if the report is of documented (i.e. expected and correct)  
Line 156: Line 313:     
====Bugzilla flags====
 
====Bugzilla flags====
 +
 
These will be obvious to the people they are intended to serve.  If you feel  
 
These will be obvious to the people they are intended to serve.  If you feel  
 
comfortable setting them based on information contained in the bug or needs  
 
comfortable setting them based on information contained in the bug or needs  
Line 182: Line 340:  
* [-+?]
 
* [-+?]
 
Set the flag to ? to say someone needs to look at it
 
Set the flag to ? to say someone needs to look at it
 +
 +
[[Category:SME Server]][[Category:SME9-Development]][[Category:Developer]]
Retrieved from "https://wiki.koozali.org/Special:MobileDiff/7326...27435"

Navigation menu