Difference between revisions of "Reporting Bugs"

Revision as of 04:31, June 21, 2014

The Funtoo community's goal is to provide a seamless and problem-free computing experience, and we take all bugs seriously. Please use the following resources for reporting bugs, technical support, and troubleshooting assistance:

IRC

The #funtoo IRC channel on freenode available for informal, real-time technical support and troubleshooting. Please use Funtoo channels rather than Gentoo channels for Funtoo Linux support.

Support Forums

The following Web-based discussion resources are specifically created for community-based support and troubleshooting, and are monitored by the Funtoo Linux core team.

Bug tracker

We are using JIRA for tracking Funtoo Linux issues. See bugs.funtoo.org to access the bug tracker.

For information on how to properly use the bug tracker, see below.

How To Report Bugs

First, Create a Funtoo account.
Go to Issues -> Create Issue
Set Issue Type to "Bug".
For Summary, enter a clear description of the defect.
For Description, enter:
1. a clear, detailed description of the problem
2. clear steps to reproduce the problem
3. output of the failure
4. a description of what you expected to happen instead of the failure

When your issue is created, it will have a short name such as FL-17 that can be used to reference it.

Each issue is intended to track a specific defect in Funtoo Linux. Please respect the focus of each individual issue. Use the mailing lists and forums for general discussion.

Bug Status

When bugs are first reported, they are marked as Awaiting Review. This means that they are waiting to be reviewed by staff. Once reviewed and possibly revised somewhat, they will be moved into Queued status. This means that the bug has been accepted and is in queue to being fixed. When a developer starts working on the bug, it will move to In Progress status. This means that the bug is being actively worked on. When the bug is resolved, it will move to Test/Integration status, which means that it will now be tested and fully integrated into Funtoo Linux. When it has been fully integrated into Funtoo Linux, it will be marked as Closed, and the resolution will be set appropriately.

There are a few other statuses that are used. Upstream Review is used when a bug is submitted to an upstream project and is awaiting review or feedback. Workaround is used when a short-term fix is used to resolve a problem, but a longer-term fix is also required. There is also a Community Discussion status. This status is used when we are actively requesting community feedback. In general, we want to use JIRA as a way to have a very focused discussion about a specific bug, so we don't want the bug comments to be used like forums posts as a type of general discussion. Use the forums for this.

Fixing Bugs

When developers fix bugs, they can reference the issue(s) being fixed in the git commit message, by saying something like "This fixes FL-22". The funtoo-overlay and flora repositories are integrated with JIRA, so you will be able to see links to these commits by going to the Commits tab for the issue.

Upstream Bug Reporting

Please report all bugs to us first, so we are aware of the issue. We will handle reporting bugs to upstream projects, including Gentoo Linux.

@@ Line 3: / Line 3: @@
 ==== IRC ====
-Our [[Funtoo_Linux:Community_portal|IRC channels]] are available for informal, real-time technical support and troubleshooting. Please use Funtoo channels rather than Gentoo channels for Funtoo Linux support.
+The <tt>#funtoo</tt> IRC channel on freenode available for informal, real-time technical support and troubleshooting. Please use Funtoo channels rather than Gentoo channels for Funtoo Linux support.
 ==== Support Forums ====
@@ Line 9: / Line 9: @@
 The following Web-based discussion resources are specifically created for community-based support and troubleshooting, and are monitored by the Funtoo Linux core team.
-* [http://forums.funtoo.org/viewforum.php?id=3 Funtoo Linux Install Central] - Web-based help with installation.
+* [http://forums.funtoo.org/index.php?/forum/7-installation-help/ Installation Help]
-* [http://forums.funtoo.org/viewforum.php?id=11 Tech Support/Troubleshooting] - Web-based general troubleshooting assistance.
+* [http://forums.funtoo.org/index.php?/forum/9-portage-help/ Portage Help]
-* [http://forums.funtoo.org/viewforum.php?id=10 Hardware Compatibility] - Web-based assistance with hardware compatibility issues.
+* [http://forums.funtoo.org/index.php?/forum/4-desktop-help/ Desktop Help]
+* [http://forums.funtoo.org/index.php?/forum/8-server-help/ Server Help]
 === Bug tracker ===
@@ Line 21: / Line 22: @@
 ==== How To Report Bugs ====
-# Create a JIRA account at [http://bugs.funtoo.org bugs.funtoo.org].
+# First, {{CreateAccount}}.
 # Go to Issues -> Create Issue
 # Set Issue Type to "Bug".
@@ Line 37: / Line 38: @@
 ==== Bug Status ====
-When bugs are first reported, they are marked as ''Awaiting Review''. This means that they are waiting to be reviewed by Daniel Robbins and the Funtoo Linux Core Team. Once reviewed and possibly revised somewhat, they will be moved into ''Queued'' status. This means that the bug has been accepted and is in queue to being fixed. When a developer starts working on the bug, it will move to ''In Progress'' status. This means that the bug is being actively worked on. When the bug is resolved, it will move to ''Test/Integration'' status, which means that it will now be tested and fully integrated into Funtoo Linux. When it has been fully integrated into Funtoo Linux, it will be marked as ''Closed'', and the resolution will be set appropriately.
+When bugs are first reported, they are marked as ''Awaiting Review''. This means that they are waiting to be reviewed by staff. Once reviewed and possibly revised somewhat, they will be moved into ''Queued'' status. This means that the bug has been accepted and is in queue to being fixed. When a developer starts working on the bug, it will move to ''In Progress'' status. This means that the bug is being actively worked on. When the bug is resolved, it will move to ''Test/Integration'' status, which means that it will now be tested and fully integrated into Funtoo Linux. When it has been fully integrated into Funtoo Linux, it will be marked as ''Closed'', and the resolution will be set appropriately.
-There are a few other statuses that are used. ''Upstream Review'' is used when a bug is submitted to an upstream project and is awaiting review or feedback. This status should not be used as a permanent resolution for a bug; it is just a temporary status. There is also a ''Community Discussion'' status. This status is used when we are actively requesting community feedback. In general, we want to use JIRA as a way to have a very focused discussion about a specific bug, so we don't want the bug comments to be used like forums posts as a type of general discussion. The ''Community Discussion'' status is used to allow a bit more open discussion (within reason) for a period of time when necessary.
+There are a few other statuses that are used. ''Upstream Review'' is used when a bug is submitted to an upstream project and is awaiting review or feedback. '''Workaround''' is used when a short-term fix is used to resolve a problem, but a longer-term fix is also required. There is also a ''Community Discussion'' status. This status is used when we are actively requesting community feedback. In general, we want to use JIRA as a way to have a very focused discussion about a specific bug, so we don't want the bug comments to be used like forums posts as a type of general discussion. Use the forums for this.
 ==== Fixing Bugs ====
 When developers fix bugs, they can reference the issue(s) being fixed in the git commit message, by saying something like "This fixes FL-22". The funtoo-overlay and flora repositories are integrated with JIRA, so you will be able to see links to these commits by going to the ''Commits'' tab for the issue.
-==== funtoo-dev Mailing List ====
-The [http://groups.google.com/group/funtoo-dev funtoo-dev mailing list] should be used for reporting vetted bugs or issues that have not been resolved on IRC or the support forums. We request that you do not use the mailing list for general troubleshooting or technical support, but instead try to use IRC or the support forums first, and then escalate to the funtoo-dev mailing list if your problem is unresolved within a reasonable time frame.
 ==== Upstream Bug Reporting ====
-Sometimes, it may be necessary to report bugs upstream, particularly to [http://bugs.gentoo.org Gentoo's Bugzilla]. You should be aware that Gentoo Linux has a habit of marking reported bugs as INVALID simply because you are running Funtoo Linux, even if they are clearly related to ebuilds that have originated from Gentoo Linux. While we find this policy to be questionable and unfortunate, it does mean that reporting bugs to [http://bugs.gentoo.org Gentoo's Bugzilla] must be handled with great care. Please follow these steps:
+Please report all bugs to us first, so we are aware of the issue. We will handle reporting bugs to upstream projects, including Gentoo Linux.
-* Try to get your bug resolved through the Funtoo Linux community resources and funtoo-dev mailing list first.
-* If you feel it is necessary to file a bug with Gentoo, please inform the Funtoo core team that you are doing so, indicate that you are using Funtoo Linux in the bug report, also mention the troubleshooting steps you have performed so far (on Funtoo infrastructure), and add <tt>staff@funtoo.org</tt> to the CC field on your bug report so that I can personally track the status of these bug reports and get involved as necessary.