5,576
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: + + + + + + − + − + + + + + + + + + + + + + + + + − [http://www.bugzilla.org/docs/tip/html/using.html General Instructions] + − for using the bug Tracker + + − ===Bug Categories===+ − 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 + + − SME Server Future + − 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.+ − Bugs that should be fixed, but not sure which future release they will be fixed in+ + + + + + + + + + + + + + + + + + + + + + − + − 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 − + − current development+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − ===Searching for bugs===+ − To help find bugs, some prepared searches have been added in the page headers.+ + + + − 1. More Prepared searchs in [[:Bugzilla Reports | Bugzilla Reports]]+ − 2. Simple search <br />+ − 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 />+ − 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 />+ − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − typically you may restrict Product to use '7.x/Future/Documentation' <br />+ − and enter a search term into either 'Summary' or 'A Comment' <br />+ − In Comment, toggle between 'contains the string' 'contains all the words' ' contains any of the words' etc. − eg. Status = CLOSED, Resolution = WONTFIX, Summary = yum <br />+ − will return about 7 bugs − eg. Status = CLOSED, Resolution = WONTFIX, A Comment = yum <br />+ − will return about 17 bugs − + + − + − + − * you can adjust your selection sets+ − + − * restrict the dates, eg between 365d and Now the last year, 60d and 7d from 2months ago but not the last week+ − * bugs you are working on or watching, add you email address to the left field in email and numbering and check cc:, commenter, etc − + − * when the bug list is displaying, add a name in the Remember field, these will show in your footer − * add the search to the [[:Bugzilla Reports | Bugzilla Reports]] page − ===Reporting Bugs===+ − 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:+ − [http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to report bugs effectively]+ − Also see [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.+ + − Anyone reporting problems, ask yourself these important questions, so that you know what to tell the developers in the bug report:+ − * What version am I using and are there any contribs installed or other customisations?+ − * What did I do?+ − * What did I expect to happen? − * What happened? − * What do the logs say? − ===Bug Verification===+ − If you find a bug you can work on, please do so. − As an example, the documentation section, only requires you to take the answer determined in the bug and copy the information onto the wiki. − There are likely to be a lot of these as they were generated before the wiki was in place. − In this example of adding documentation, + − + − + − + − + − + + + + + + Line 105:
Line 244: − + − + + + + + + + + − ---- Line 126:
Line 271: − + Line 168:
Line 313: + Line 195:
Line 341: − ====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. − − Reread [http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to report bugs effectively] − − Now look at the bug reports in Bugzilla with your developer hat on. − − * Go into triage mode − * Ask the questions asked by the essay − * Get the information from the reporter − * Reproduce the issue − * Confirm the bug or mark it invalid if you can't reproduce it − * Summarise the issue if the report isn't clear − * Add a note about a workaround/fix if one is obvious to you − * That fix may not be the one we adopt, but it often helps if you tell us what you did to fix it
→Verifying Bugs
<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
You don't have to be a programmer to help or use the bug tracker.
===Bugzilla is easy===
Bugs also include fixing and making suggestions on documentation, translations and the SME Server web sites.
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
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.
'''Component:''' As accurately as possible, you may choose which category your issue fits into. If Unknown then choose UNKNOWN.
'''Found-in-version:''' Usually self explanatory. If it applies to more than one version, choose the most recent stable release.
'''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.
* Good: "Canceling a File Copy dialog crashes File Manager"
* 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'''''
SME Server Release 7.X
eg. SME Server 7.1, Updated to 7.3 with yum
SME Server Release 8.X
'''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.'''''
'''ACTUAL RESULTS''': '''''List what you got as a result.'''''
'''EXPECTED RESULTS''': '''''List what you expected to happen.'''''
'''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.
Finally, when satisfied with your entries, submit your bug report by pressing the '''COMMIT''' button.
===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]].
'''Information from here is used in the Updates Announcements and if you use this format, it will save duplication of work'''
Other Products can be Closed after being fixed, as they are not part of the updates process.
The bug report will detail the exact package and version needed. These are normally in smeupdates-testing and can be installed by :
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:
Use Control Click to select/deselect from selection sets, if none are selected all are.
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
*Modifying your search
*SME Server Future
- Bugs can be moved to future if they can be classified as NewFeatureRequest
- Click on the hyperlinked headers to sort your list
- or as cleanup functionality that does not have a major (user-visible) impact.
- Click 'Edit Search' near the page footer
- Bugs that should be fixed, but not sure which future release they will be fixed in
* add a search tern in the summary or comments fields
*SME Server Release 7.X
- The error is severe enough that we need to fix it, taking time away from 9.x development
- If you have a favourite search,
- The bug is being worked on actively
- The bug has been cloned from 8.x for backporting
*SME Server Release 8.X
- The error is severe enough that we need to fix it, taking time away from 9.x development
- The bug is being worked on actively
*SME Server Release 9.X
- current development
====Bug Triage====
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]
Now look at the bug reports in Bugzilla with your developer hat on.
* find a bug where you understand the problem resolved
* update the wiki, information will go in a manual, be added to the FAQ or a howto, or create a new howto
* Go into triage mode this page can help You : [[Bugzilla_Reports]]
* return to the bug post brief details of the fix, and how to verify it, eg 'updated wiki re: passwords' and give the URL
* Ask the questions asked by the essay
* then change the Status to 'Resolved - Fixed'.
* Get the information from the reporter
* let someone else verify, or verify someone else's work
* Reproduce the issue
* Confirm the bug or mark it invalid if you can't reproduce it
* Summarise the issue if the report isn't clear
* Add a note about a workaround/fix if one is obvious to you
* That fix may not be the one we adopt, but it often helps if you tell us what you did to fix it
====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]
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,
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)
====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
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]]