1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-09-20 09:18:48 +02:00

More adjustments to bug reporting document

Summary:
Ref T12922.

  - Tell customers where to go at the top.
  - Fix a couple minor things (e.g., don't advise users to reproduce on `secure` anymore).

Test Plan: Read carefully.

Reviewers: chad, avivey

Reviewed By: chad, avivey

Maniphest Tasks: T12922

Differential Revision: https://secure.phabricator.com/D18236
This commit is contained in:
epriestley 2017-07-18 10:45:17 -07:00
parent 1fdd809d35
commit 2999e19742

View file

@ -3,32 +3,33 @@
Describes how to file an effective Phabricator bug report. Describes how to file an effective Phabricator bug report.
Include Reproduction Steps! Level Requirements
=========================== ==================
IMPORTANT: When filing a bug report, you **MUST** include reproduction We accept bug reports through two channels: paid support and community
instructions. We can not help fix bugs we can not reproduce, and will not support.
accept reports which omit reproduction instructions.
For help, see @{article:Providing Reproduction Steps}. If you are a paying customer, use the
[[ https://admin.phacility.com/u/support | Support Channel ]] for your account
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.
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.
@ -139,8 +140,8 @@ 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
@ -149,28 +150,20 @@ 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.
You can file a report on the community forum, here:
(NOTE) https://discourse.phabricator-community.org/c/bug (NOTE) https://discourse.phabricator-community.org/c/bug
For Phacility Customers
=======================
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
========== ==========