Changeset View
Changeset View
Standalone View
Standalone View
src/docs/contributor/bug_reports.diviner
@title Contributing Bug Reports | @title Contributing Bug Reports | ||||
@group detail | @group detail | ||||
Describes how to file an effective Phabricator bug report. | Describes how to file an effective Phabricator bug report. | ||||
Include Reproduction Steps! | Level Requirements | ||||
=========================== | ================== | ||||
We accept bug reports through two channels: paid support and community | |||||
support. | |||||
IMPORTANT: When filing a bug report, you **MUST** include reproduction | If you are a paying customer, use the | ||||
instructions. We can not help fix bugs we can not reproduce, and will not | [[ https://admin.phacility.com/u/support | Support Channel ]] for your account | ||||
accept reports which omit reproduction instructions. | to report bugs. This document may help you file reports which we can resolve | ||||
more quickly, but you do not need to read it or follow the guidelines. | |||||
For help, see @{article:Providing Reproduction Steps}. | Other users can follow the guidelines in this document to file bug reports on | ||||
the community forum. | |||||
Overview | Overview | ||||
======== | ======== | ||||
Found a bug with Phabricator? Let us know! This article describes how to file | This article describes how to file an effective Phabricator bug report. | ||||
an effective bug report so we can get your issue fixed or help you work around | |||||
it. | |||||
The most important things to do are: | The most important things to do are: | ||||
- check the list of common fixes below; | - check the list of common fixes below; | ||||
- make sure Phabricator is up to date; | - make sure Phabricator is up to date; | ||||
- make sure we support your setup; | - make sure we support your setup; | ||||
- gather debugging information; | - gather debugging information; and | ||||
- explain how to reproduce the issue; and | - explain how to reproduce the issue. | ||||
- create a task in | |||||
[[ http://secure.phabricator.com/u/newbug/ | Maniphest ]]. | |||||
The rest of this article walks through these points in detail. | The rest of this article walks through these points in detail. | ||||
For general information on contributing to Phabricator, see | For general information on contributing to Phabricator, see | ||||
@{article:Contributor Introduction}. | @{article:Contributor Introduction}. | ||||
Common Fixes | Common Fixes | ||||
▲ Show 20 Lines • Show All 94 Lines • ▼ Show 20 Lines | - Some other things, like daemons, have their own debug flags or | ||||
you more information about the issue. | you more information about the issue. | ||||
Reproducibility | Reproducibility | ||||
=============== | =============== | ||||
The most important part of your report content is instructions on how to | The most important part of your report content is instructions on how to | ||||
reproduce the issue. What did you do? If you do it again, does it still break? | reproduce the issue. What did you do? If you do it again, does it still break? | ||||
Does it depend on a specific browser? Can you reproduce the issue on | Does it depend on a specific browser? Can you reproduce the issue on a free | ||||
`secure.phabricator.com`? | instance on `admin.phabricator.com`? | ||||
It is nearly impossible for us to resolve many issues if we can not reproduce | It is nearly impossible for us to resolve many issues if we can not reproduce | ||||
them. We will not accept reports which do not contain the information required | them. We will not accept reports which do not contain the information required | ||||
to reproduce problems. | to reproduce problems. | ||||
For help, see @{article:Providing Reproduction Steps}. | For help, see @{article:Providing Reproduction Steps}. | ||||
For Open Source Users | File a Bug Report | ||||
===================== | ================= | ||||
If you're up to date, supported, have collected information about the problem, | If you're up to date, have collected information about the problem, and have | ||||
and have the best reproduction instructions you can come up with, you're ready | the best reproduction instructions you can come up with, you're ready | ||||
to file an issue. | to file a report. | ||||
It is **particularly critical** that you include reproduction steps. We will | It is **particularly critical** that you include reproduction steps. | ||||
not accept reports which describe issues we can not reproduce. | |||||
(NOTE) https://discourse.phabricator-community.org/c/bug | |||||
You can file a report on the community forum, here: | |||||
For Phacility Customers | (NOTE) https://discourse.phabricator-community.org/c/bug | ||||
======================= | |||||
If you've encountered a bug via a Phacility instance or have a paid support | |||||
contract with Phacility, you can find more information on how to get help via | |||||
[[ https://admin.phacility.com/book/phacility/article/support/ | Phacility | |||||
Support ]]. | |||||
Next Steps | Next Steps | ||||
========== | ========== | ||||
Continue by: | Continue by: | ||||
- reading general support information in @{article:Support Resources}; or | - reading general support information in @{article:Support Resources}; or | ||||
- returning to the @{article:Contributor Introduction}. | - returning to the @{article:Contributor Introduction}. |