Difference between revisions of "Moderating the bug tracker"

From Lazarus wiki
Jump to navigationJump to search
 
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Moderating the bug tracker}}
 
{{Moderating the bug tracker}}
  
This document contains some guidelines for using the Lazarus [http://bugs.freepascal.org/view_all_bug_page.php?project_id=1 bug tracker]. This document is written for two groups:
+
This document contains some guidelines for moderating the Lazarus [https://gitlab.com/freepascal.org/lazarus/lazarus/-/issues bug tracker].<br>
* lazarus developers, who will try to fix bugs
+
Moderating the bugtracker can only be done by Lazarus developers.  
* moderators, who will support the handling of issue by prioritizing them and making sure that they reproduceable.
 
We will use the term '''Lazarus team''' for both groups.
 
  
== Life cycle of an issue ==
+
== Referring questions to the mailing list and forums ==
An issue can have the following states:
+
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.
* new: it has entered in the bug tracker
 
* acknowledged: the Lazarus team has seen the issue and has set its target
 
* confirmed: a member of the Lazarus team has duplicated the bug or agrees that the feature should be implemented
 
* assigned: the issue has been assigned to a Lazarus developer, who will try to fix it
 
* resolved: the person to whom the issue was assigned thinks the issue can be closed. Then he also sets the resolution, for example '''fixed''' or '''not an issue'''.
 
* closed: the reporter tested the fix and agrees with the fix. Periodically resolved issues that have not been closed by the reporter, will be a closed by the bug tracker administrator.
 
  
== How can moderators support the Lazarus developers? ==
+
== 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.
  
=== Acknowledging issues ===
+
== Adding relations to other issues ==
==== Setting the target ====
 
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 minor release''' (e.g. 1.6.2), '''post next major release''' (e.g. 1.8) or '''post next major release''' (e.g. post 1.8). For an explanation of these options, see [[Road To 1.0#1.0 or after 1.0]].
 
 
 
* next minor release: patches, regressions (i.e. things that work in the current release, but got broken in the svn version) and crashes that can cause data loss.
 
* next major release: improvements, major design changes, new features.
 
* post next major release: things that are not likely to be fixed or incuded in the next major release (e.g. new widgetset).
 
 
 
There are two fields for the target:
 
* LazTarget, which can be used to select issues for several (sub-)projects at once, for example Lazarus, Lazarus/packages and Lazarus/patches.
 
* Target version, which is used by the [http://bugs.freepascal.org/roadmap_page.php road map].
 
 
 
==== 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. Sometimes the bugtracker takes a long time to process the new report and the reporter gets impatient and clicks on submit again. Such 'issues' can be deleted.
 
 
 
==== 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 can resolve the issue with resolution "'''no change required'''". 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.
 
 
 
==== Adding relations to other issues ====
 
 
The bug tracker supports setting relations between 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.
+
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 two reports decribe the same issue, then you can set '''Duplicate of''' to the newest report. The other report then receives a link to that issue with '''Has duplicate'''.
+
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.
  
You can use the '''Parent - Child''' relation between two issues to describe dependency. In order to fix the '''Parent''' issue, the '''Child''' issue must be fixed first. Sometimes it is usefull to ''clone'' a (big) issue and describe part of it in a separate '''Child''' issue.
+
== 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.
  
==== Moving to the patches subproject ====
+
== Moving an issue to the Lazarus-CCR bug tracker ==
Patches can be moved to the patches subproject. Patches are more visible there and can be managed separately from other issues.
+
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].
  
==== Referring to the fpc bug tracker ====
+
== Confirming issues ==
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.
 
 
 
==== Referring 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: you should move them 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.
 
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 it is not clear from the Mantis bug report, you can ask the reporter to give steps to reproduce this issue and/or a test project.
+
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.
  
If you manage to reproduce the issue, then you can set the issue to '''Confirmed'''.
+
== 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 ===
+
== Assigning issues to yourself ==
 
If you think you can fix a reported issue, you can assign the issue to yourself.<br>
 
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>
 
Other users, including the original reporter will then know the issue is under someones attention.<br>
Once you have provided a patch [http://wiki.lazarus.freepascal.org/Creating_A_Patch] you then set the target to the next stable release and unassign the issue (assign to nobody). This will signal to the maintainers that a patch is being offered for review.<br>
+
If it turns out that you are unable to fix the issue you have assigned to yourself, simply remove yourself as assignee.
If it turns out that you are unable to fix the issue you have assigned to yourself, simply unassign it.
 
  
 +
== 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 ===
+
== 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.
 
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.
 
==Tags==
 
 
Below is a table with the tags utilized to mark groups of bug reports which aren't easily defined by the other options and their description.
 
 
{| class="wikitable"
 
! Tag !! Description
 
|-
 
|gtk2||Represents all gtk2 specific bugs and is used to track what needs to be fixed before gtk2 becomes the default Linux widgetset.
 
|}
 
  
 
==See also==
 
==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.
 
* [[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.
 
[[category:Debugging]]
 
[[Category:Guidelines]]
 
[[Category:FPC Issues‏‎]]
 
[[Category:SOPs]]
 

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