Difference between revisions of "Moderating the bug tracker"

From Lazarus wiki
 
m (Setting a Milestone)
 
(61 intermediate revisions by 11 users not shown)
Line 1: Line 1:
This document contains some guidelines for using the Lazarus [http://www.lazarus.freepascal.org/mantis/ bug tracker]. This document is written for two groups:
+
{{Moderating the bug tracker}}
* lazarus developers, who will try to fix bugs
 
* moderators, who will support the handling of issue by priotizing them and making sure that they reproduceable.
 
We will use the term '''Lazarus team''' for both groups.
 
  
== Life cycle of an issue ==
+
This document contains some guidelines for moderating the Lazarus [https://gitlab.com/freepascal.org/lazarus/lazarus/-/issues bug tracker].<br>
An issue can have the following states:
+
Moderating the bugtracker can only be done by Lazarus developers.  
* new: it has entered in the bug tracker
 
* acknowledged: the Lazarus team has seen the issue and has set its target
 
* assigned: the issue has been assigned to a lazarus developer, who will try to fix it
 
* confirmed: a member of the Lazarus team has duplicated the bug or agrees that the feature should be implemented
 
* resolved: the person to who the issue was assigned thinks the issue can be closed. Then he also sets the resolution, for example '''fixed''' or '''not an issue'''.
 
  
== How can moderators support the Lazarus developers ==
+
== Referring questions to the mailing list and forums ==
 +
If an issue doesn't describe a bug, but is only question (or the reporter doesn't know how to use certain feature) you can refer him to the mailing list and/or the forums to ask his question. Then you close the isse and optionally add the label "Resolution: not a bug" to the report. If you wish, you can provide a short answer to his question, but the bug tracker is for entering bugs and feature requests, not for providing support.
  
=== Acknowledging issues ===
+
== Removing duplicate entries ==
==== Setting the target ====
+
When looking at a 'new' issue, you may need to remove duplicates that have arisen because people submitted the same issue more than once. Such 'issues' should be closed and a relationship "Duplicate" should be added, optionally a label "Resolution: Duplicate" could be added.
The most important step when you acknowledge an issue, is that you set the target field. The target field helps the lazarus developers to prioritize their bug fixing effort. Generally there are three options: '''next release''', '''1.0''' or '''post 1.0'''. For an explanation of these options, see [[Road To 1.0#1.0 or after 1.0]].
 
  
==== Removing duplicate entries ====
+
== Adding relations to other issues ==
When looking at new issue, you can also remove duplicated that are caused, because people submitted the same issue more than once. Sometimes the bugtracker takes a long time to process the new report and the reporter gets impatients and clicks on submit again. Those issues can be deleted.
+
The bug tracker supports setting relations between issues.  
  
==== Refering questions to the mailing list and forums ====
+
The weakest relation is '''Related'''. This merely links the two issues. This can be useful since if you fixed one issue, it may fix the related issue(s) too. You can use [https://docs.gitlab.com/ee/user/project/quick_actions.html QuickACtions] to set a relationship.
If an issue doesn't describe a bug, but is only question or the reporter doesn't know how to use certain feature, you can refer him to the mailing list and/or the forums to ask his question. Then you can resolve the issue with status ''not an issue''. If you wish you can provide a short answer to the question, but the bug tracker is to enter bugs and feature request, not to provide support.
 
  
==== Adding relations with other issues ====
+
If two reports decribe the same issue, then you can set '''Duplicate of''' to the newest report. You can use [https://docs.gitlab.com/ee/user/project/quick_actions.html QuickACtions] to set this relationship.
  
==== Refering to the fpc bug tracker ====
+
== Moving an issue to the fpc bug tracker ==
 +
If a bug is not in the IDE or the LCL, but in the RTL, FCL or the compiler, you can move the issue to the FPC project in the bug tracker.<br>
 +
Currently only devlopers who also have developer access to the [https://gitlab.com/freepascal.org/lazarus-sandbox/lazarus_testconversion/-/issues fpc bugtracker] can do this.
  
=== Confirming issues ===
+
== Moving an issue to the Lazarus-CCR bug tracker ==
Most of the time, the first step in fixing an issue, is creating a small example program that shows the issue. How difficult this is depends on the effort the reporter has made, when he submitted the report. Some people test programs to their report (very nice), some people only a code snippet (better than nothing) and some people nothing at all. Not all reports have adequate steps to reproduce.
+
Some projects or components hosted on Lazarus-CCR use the Lazarus bug tracker for tracking issues. Those issues should not reside in the Lazarus project: they should be moved to the [https://gitlab.com/freepascal.org/lazarus/ccr/-/issues Lazarus CCR bug tracker].
  
If it is not clear from the report, you can ask the reporter the give steps to reproduce this issue and/or a test project.
+
== Confirming issues ==
 +
Most of the time, the first step in fixing an issue is creating a small example program that demonstrates the issue. Reporters vary in the effort they make when submitting their initial report. Some people add test programs to their report (very nice), some people only add a code snippet (better than nothing) and some people add nothing at all. Not all reports provide adequate steps for others to reproduce the supposed issue. Going to the length of adding a small, compilable example program speeds identification and resolution of the issue you have identified.
  
If you manage to reproduce the issue, then you can set the issue to '''Confirmed'''.
+
If you manage to reproduce the issue, then you can add the label "Status: Confirmed" (you can use [https://docs.gitlab.com/ee/user/project/quick_actions.html QuickACtions] for that), or simply just say so in a comment.
 +
 
 +
== Asking for feedback ==
 +
If it is unclear how to reproduce an issue (e.g. no code example, bug may rely on compiler options etc.) then you should ask the reporter for feedback.<br>
 +
You can use [https://docs.gitlab.com/ee/user/project/quick_actions.html QuickACtions] to add the label "Status: Feedback" and it is best to also "hail" the reporting using @reporters_username in the message.
 +
 
 +
== Assigning issues to yourself ==
 +
If you think you can fix a reported issue, you can assign the issue to yourself.<br>
 +
Other users, including the original reporter will then know the issue is under someones attention.<br>
 +
If it turns out that you are unable to fix the issue you have assigned to yourself, simply remove yourself as assignee.
 +
 
 +
== Setting a Milestone ==
 +
When resolving (fixing) an issue (or when assigning), a developer may set a milstone.<br>
 +
This, however is not a guarantee that a fix will make it into the chosen version.
 +
 
 +
== GTK 1 issues ==
 +
The gtk (i.e. the gtk version 1) widget set is not actively supported anymore by the Lazarus team, see [http://lists.lazarus.freepascal.org/pipermail/lazarus/2009-November/047069.html announcement]. If there is no problem when the gtk2 widget set is used instead, then the issue can be resolved with state suspended.
 +
 
 +
==See also==
 +
* [[How do I create a bug report]] general information on submitting bugs, what should be covered in a bug report, and using the bug tracker.

Latest revision as of 13:48, 28 September 2021

Deutsch (de) English (en) français (fr) português (pt) русский (ru)

This document contains some guidelines for moderating the Lazarus bug tracker.
Moderating the bugtracker can only be done by Lazarus developers.

Referring questions to the mailing list and forums

If an issue doesn't describe a bug, but is only question (or the reporter doesn't know how to use certain feature) you can refer him to the mailing list and/or the forums to ask his question. Then you close the isse and optionally add the label "Resolution: not a bug" to the report. If you wish, you can provide a short answer to his question, but the bug tracker is for entering bugs and feature requests, not for providing support.

Removing duplicate entries

When looking at a 'new' issue, you may need to remove duplicates that have arisen because people submitted the same issue more than once. Such 'issues' should be closed and a relationship "Duplicate" should be added, optionally a label "Resolution: Duplicate" could be added.

Adding relations to other issues

The bug tracker supports setting relations between issues.

The weakest relation is Related. This merely links the two issues. This can be useful since if you fixed one issue, it may fix the related issue(s) too. You can use QuickACtions to set a relationship.

If two reports decribe the same issue, then you can set Duplicate of to the newest report. You can use QuickACtions to set this relationship.

Moving an issue to the fpc bug tracker

If a bug is not in the IDE or the LCL, but in the RTL, FCL or the compiler, you can move the issue to the FPC project in the bug tracker.
Currently only devlopers who also have developer access to the fpc bugtracker can do this.

Moving an issue to the Lazarus-CCR bug tracker

Some projects or components hosted on Lazarus-CCR use the Lazarus bug tracker for tracking issues. Those issues should not reside in the Lazarus project: they should be moved to the Lazarus CCR bug tracker.

Confirming issues

Most of the time, the first step in fixing an issue is creating a small example program that demonstrates the issue. Reporters vary in the effort they make when submitting their initial report. Some people add test programs to their report (very nice), some people only add a code snippet (better than nothing) and some people add nothing at all. Not all reports provide adequate steps for others to reproduce the supposed issue. Going to the length of adding a small, compilable example program speeds identification and resolution of the issue you have identified.

If you manage to reproduce the issue, then you can add the label "Status: Confirmed" (you can use QuickACtions for that), or simply just say so in a comment.

Asking for feedback

If it is unclear how to reproduce an issue (e.g. no code example, bug may rely on compiler options etc.) then you should ask the reporter for feedback.
You can use QuickACtions to add the label "Status: Feedback" and it is best to also "hail" the reporting using @reporters_username in the message.

Assigning issues to yourself

If you think you can fix a reported issue, you can assign the issue to yourself.
Other users, including the original reporter will then know the issue is under someones attention.
If it turns out that you are unable to fix the issue you have assigned to yourself, simply remove yourself as assignee.

Setting a Milestone

When resolving (fixing) an issue (or when assigning), a developer may set a milstone.
This, however is not a guarantee that a fix will make it into the chosen version.

GTK 1 issues

The gtk (i.e. the gtk version 1) widget set is not actively supported anymore by the Lazarus team, see announcement. If there is no problem when the gtk2 widget set is used instead, then the issue can be resolved with state suspended.

See also