issues.rst: Use definition lists instead of plain lists
This commit is contained in:
+33
-23
@@ -16,39 +16,49 @@ Examples include "Duplicate of #123", "Discovered to be configuration
|
|||||||
error", "Rendered moot by #123" and so on. We don't use the "invalid" or
|
error", "Rendered moot by #123" and so on. We don't use the "invalid" or
|
||||||
"wontfix" labels.
|
"wontfix" labels.
|
||||||
|
|
||||||
- **android** - Marks an issue as occurring on the Android platform
|
android
|
||||||
only.
|
Marks an issue as occurring on the Android platform only.
|
||||||
|
|
||||||
- **bug** - The issue is a verified bug.
|
bug
|
||||||
|
The issue is a verified bug.
|
||||||
|
|
||||||
- **build** - The issue is caused by or requires changes to the build
|
build
|
||||||
system (scripts or Docker image).
|
The issue is caused by or requires changes to the build system
|
||||||
|
(scripts or Docker image).
|
||||||
|
|
||||||
- **docs** - Something requires documenting.
|
docs
|
||||||
|
Something requires documenting.
|
||||||
|
|
||||||
- **easy** - This could be easily fixed, probably an hour's work or
|
easy
|
||||||
less. These issues are good starting points for new contributors.
|
This could be easily fixed, probably an hour's work or less.
|
||||||
|
These issues are good starting points for new contributors.
|
||||||
|
|
||||||
- **enhancement** - This is a new feature or an improvement of some
|
enhancement
|
||||||
kind, as opposed to a problem (bug).
|
This is a new feature or an improvement of some kind, as
|
||||||
|
opposed to a problem (bug).
|
||||||
|
|
||||||
- **help-wanted** - The core team can't or won't do this, but someone
|
help-wanted
|
||||||
else is welcome to. This does not mean that help is not wanted on the
|
The core team can't or won't do this, but someone else is welcome
|
||||||
*other* issues. You can see this as a soft ``wontfix``. (A hard
|
to. This does not mean that help is not wanted on the *other*
|
||||||
``wontfix`` is simply a close with a short explanation why.)
|
issues. You can see this as a soft ``wontfix``. (A hard ``wontfix``
|
||||||
|
is simply a close with a short explanation why.)
|
||||||
|
|
||||||
- **pr-bugfix** - This pull request *fixes* a bug. This is different
|
pr-bugfix
|
||||||
from the ``bug`` label, as there may also be pull requests with for
|
This pull request *fixes* a bug. This is different from the ``bug``
|
||||||
example tests that *prove* a bug which would then be labeled ``bug``.
|
label, as there may also be pull requests with for example tests
|
||||||
|
that *prove* a bug which would then be labeled ``bug``.
|
||||||
|
|
||||||
- **pr-refactor** - This pull request is a refactoring, i.e. not
|
pr-refactor
|
||||||
supposed to change behavior.
|
This pull request is a refactoring, i.e. not supposed to change
|
||||||
|
behavior.
|
||||||
|
|
||||||
- **pr-wait-or-pending** - This pull request is not ready for merging,
|
pr-wait-or-pending
|
||||||
even if the tests pass and it looks good. It is incomplete or
|
This pull request is not ready for merging, even if the tests
|
||||||
requires more discussion.
|
pass and it looks good. It is incomplete or requires more
|
||||||
|
discussion.
|
||||||
|
|
||||||
- **protocol** - This requires a change to the protocol.
|
protocol
|
||||||
|
This requires a change to the protocol.
|
||||||
|
|
||||||
Milestone
|
Milestone
|
||||||
---------
|
---------
|
||||||
|
|||||||
Reference in New Issue
Block a user