-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Issue prefix proposal
Mark Mikofski edited this page Feb 14, 2018
·
6 revisions
Issues and pull requests can be prefixed to help maintainers and contributors identify them quickly.
| prefix | meaning |
|---|---|
| ENH | enhancement, feature request, ... |
| WIP | work in progress, not ready, do not merge, ... |
| BUG | bug, issue, ticket, problem, ... |
| DOC | Documentation, tutorials, examples, ... |
| MNT | maintenance, clean up, requirements, setup ... |
| TST | testing, unit-testing, end-to-end, ... |
| BLD | build, CI, deployment, requirements, ... |
There may be some overlap with prefixes, like BLD and MNT. Prefixes can be chained together. For example:
BUG:ENH:WIP: Limit overflow in 4th quadrant using piecewise, constant resistance model
Using a common set of guidelines can help organize issues which may allow them to be resolve more easily, and at the very least may reduce some clutter. Other repositories have adopted similar styles at least for their pull requests, such as: NumPy and SciPy.
This is a proposal. This is not an requirement. These are just suggestions. Feel free to edit this wiki to add, alter, or remove anything as you see fit.