OmnibusBugReportPolicy
From AWN Wiki
Contents |
[edit] Omnibus Bug Report Policy
[edit] Rationale
Bug reports and feature requests are greatly appreciated by the AWN developers. However, bug reports that incorporate multiple issues/requests in the same bug are not easily manageable within the bug reporting framework. If you have been referred to this page after filing a bug report please refile your bug in the suggested manner. Cooperation is greatly appreciated and allows AWN developers to spend more time coding and less timing managing bugs.
[edit] The Problem with Omnibus Bug Reports
- Management of bug status tends to be incoherent. If multiple issues are in various stages of progress it is extremely problematic to correctly track the status of the bug. This can be illustrated by considering the question of how to deal with a one of these bugs where one of the issues should be marked "won't fix", another should be marked "invalid" and another should be marked "fix committed".
- Increased time managing the bug. Every time the bug is viewed a developer needs to filter through all the requests and determine which are still relevant and which have been closed. If you divide a bug that speaks about 5 separate issues into 5 separate bugs then once one of those bugs is closed it is removed from view. If they are all placed in the same bug report they all remain in view until such time as the bug as a whole is closed.
- Decreased attention. Large, multi-issue, bugs are often ignored by developers for the reasons mentioned above.
[edit] Resolution
- Bugs that are filed with multiple, unrelated, issues listed will be marked "won't fix" and a link will be provided to this document. Please refile the bugs following the guidelines listed in this document and here.
[edit] How to submit multiple issues
- One issue per bug unless the issues are all aspects of a single issue. If you're unsure then submit as multiple bugs and bug triagers will mark one or more as duplicates if necessary.
- One bug per applet if submitting the bugs in awn-extras. Bugs (even similar ones) affecting applets often get resolved with widely varying speed since they are often maintained by different developers with very different schedules and availability.
- If it appears to be an issue within AWN core that happens to be affecting multiple applets then make the bug report in the AWN core bug tracker and list the applets affected. Please note that there is a possibility that the bug may be determined to be applet specific and moved to awn-extras and pursuant to this policy marked "won't fix".
- Feature requests are treated in the same manner as traditional bugs. Simple feature requests are also more acceptable in the context of a bug report. Larger, more complicated, features requests are encourage to be filed as a Blueprint.
