Bug management/Phabricator etiquette
Please follow these guidelines to ensure that Phabricator is a productive and collaborative environment for managing bug reports and feature requests.
You must also follow the Code of Conduct.
- Comments should be directly related to reporting, confirming, evaluating the severity, or fixing the bug. Thoughts unrelated to the topic of the report (for example, meta-level discussions on priorities in general or on whether a new extension is wanted at all) should go to the appropriate mailing lists, wiki talk pages, or separate reports.
- Criticise ideas, not people. A healthy amount of constructive criticism and vibrant debate helps to improve our software and is encouraged.
- Act in public. Unless you are reporting a security issue or you were asked to email somebody with specific information, place all technical information relating to a bug report in the report itself.
- Report status and priority fields summarise and reflect reality and do not cause it. Read about the meaning of the Priority field values and, when in doubt, do not change them, but add a comment suggesting the change and convincing reasons for it.
- As a general rule, the fastest way to see a bug resolved is to provide a patch (see also Development prioritisation).
- Convincing reasons for raising the priority of a bug include evidence that it affects normal, everyday work significantly. Contrived examples or problems that only appear under unlikely circumstances are generally evidence for treating the problem as "low" priority, since the limits of any non-trivial software can be exceeded if you try hard enough.
- Do not post votes or comments like "Fix this now".
- Only manually assign a task to someone if they have given their prior agreement. It is up to developers (or their product managers) what they plan to work on.
- Prefer using Phabricator usernames (e.g. @username) over a person's real name or other personal identifiers. To address both concerns regarding privacy and unnecessary confusion, when communicating on various tasks, pastes, phame posts, etc, please use Phabricator usernames. Even if you know individuals on a personal level (real name, etc.) they may not wish to have that information associated with their Phabricator username. It also presents a layer of confusion for other Phabricator users who are not aware of someone's real name or other personal identifiers.
If you see someone not following these guidelines or not being productive:
- The first step is to contact them. This can be done through private email in minor cases, or in public in major cases to avoid any later assumptions of tolerated behaviour.
- Be informative – Tell what they are doing what they should not do. If pertinent, make them aware of this document.
- Be catalytic – Tell what they should do instead. Occasionally this may be encouraging and motivating, better than a dense list of "rules".
- In the case of persistent disregard of these guidelines, ping a Phabricator administrator in connect on Wikimedia IRC or contact the bugwrangler and ask them to look into it. In case the disregard can be seen as unacceptable behaviour defined by the Code of Conduct, the Code of Conduct committee will be informed.
Document inspiration edit
- Mozilla etiquette
- Bugzilla dos and don'ts at Mozilla Developer Network
- Conversation on teampractices mailing list, referring to the use of RESOLVED WONTFIX in Bugzilla (now "declined" in Phabricator) and related problems
See also edit
- Failure is Always An Option: How a Blameless Culture Leads to Better Results, Jessica Kahn, September 08, 2016