You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Will Holmgren edited this page Feb 27, 2020
·
6 revisions
Proposal
Issues and pull requests can be prefixed to help maintainers and contributors identify them quickly.
Proposed prefixes
prefix
meaning
ENH
enhancement, feature request, ...
WIP
work in progress, not ready, do not merge, ...
BUG
bug, issue, ticket, problem, ...
DOC
Documentation, tutorials, examples, ...
MAINT
maintenance, clean up, requirements, setup ...
TST
testing, unit-testing, end-to-end, ...
BLD
build, CI, deployment, requirements, ...
DEPR
deprecation, new feature, futures, ...
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
Rationale
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.
Disclaimer
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.
Comments
@wholmgren: What's the point of doing this when we already use github labels? I've never understood why numpy/scipy/pandas do this in addition to labels.