Merge pull request #3371 from nicoddemus/remove-labels-descriptions
Remove label descriptions from development guide
This commit is contained in:
commit
5d4fe87b72
|
@ -2,7 +2,7 @@
|
||||||
Development Guide
|
Development Guide
|
||||||
=================
|
=================
|
||||||
|
|
||||||
Some general guidelines regarding development in pytest for core maintainers and general contributors. Nothing here
|
Some general guidelines regarding development in pytest for maintainers and contributors. Nothing here
|
||||||
is set in stone and can't be changed, feel free to suggest improvements or changes in the workflow.
|
is set in stone and can't be changed, feel free to suggest improvements or changes in the workflow.
|
||||||
|
|
||||||
|
|
||||||
|
@ -37,72 +37,19 @@ Any question, feature, bug or proposal is welcome as an issue. Users are encoura
|
||||||
GitHub issues should use labels to categorize them. Labels should be created sporadically, to fill a niche; we should
|
GitHub issues should use labels to categorize them. Labels should be created sporadically, to fill a niche; we should
|
||||||
avoid creating labels just for the sake of creating them.
|
avoid creating labels just for the sake of creating them.
|
||||||
|
|
||||||
Here is a list of labels and a brief description mentioning their intent.
|
Each label should include a description in the GitHub's interface stating its purpose.
|
||||||
|
|
||||||
|
Temporary labels
|
||||||
|
~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
**Type**
|
To classify issues for a special event it is encouraged to create a temporary label. This helps those involved to find
|
||||||
|
the relevant issues to work on. Examples of that are sprints in Python events or global hacking events.
|
||||||
|
|
||||||
* ``type: backward compatibility``: issue that will cause problems with old pytest versions.
|
* ``temporary: EP2017 sprint``: candidate issues or PRs tackled during the EuroPython 2017
|
||||||
* ``type: bug``: problem that needs to be addressed.
|
|
||||||
* ``type: deprecation``: feature that will be deprecated in the future.
|
|
||||||
* ``type: docs``: documentation missing or needing clarification.
|
|
||||||
* ``type: enhancement``: new feature or API change, should be merged into ``features``.
|
|
||||||
* ``type: feature-branch``: new feature or API change, should be merged into ``features``.
|
|
||||||
* ``type: infrastructure``: improvement to development/releases/CI structure.
|
|
||||||
* ``type: performance``: performance or memory problem/improvement.
|
|
||||||
* ``type: proposal``: proposal for a new feature, often to gather opinions or design the API around the new feature.
|
|
||||||
* ``type: question``: question regarding usage, installation, internals or how to test something.
|
|
||||||
* ``type: refactoring``: internal improvements to the code.
|
|
||||||
* ``type: regression``: indicates a problem that was introduced in a release which was working previously.
|
|
||||||
|
|
||||||
**Status**
|
Issues created at those events should have other relevant labels added as well.
|
||||||
|
|
||||||
* ``status: critical``: grave problem or usability issue that affects lots of users.
|
Those labels should be removed after they are no longer relevant.
|
||||||
* ``status: easy``: easy issue that is friendly to new contributors.
|
|
||||||
* ``status: help wanted``: core developers need help from experts on this topic.
|
|
||||||
* ``status: needs information``: reporter needs to provide more information; can be closed after 2 or more weeks of inactivity.
|
|
||||||
|
|
||||||
**Topic**
|
|
||||||
|
|
||||||
* ``topic: collection``
|
|
||||||
* ``topic: fixtures``
|
|
||||||
* ``topic: parametrize``
|
|
||||||
* ``topic: reporting``
|
|
||||||
* ``topic: selection``
|
|
||||||
* ``topic: tracebacks``
|
|
||||||
|
|
||||||
**Plugin (internal or external)**
|
|
||||||
|
|
||||||
* ``plugin: cache``
|
|
||||||
* ``plugin: capture``
|
|
||||||
* ``plugin: doctests``
|
|
||||||
* ``plugin: junitxml``
|
|
||||||
* ``plugin: monkeypatch``
|
|
||||||
* ``plugin: nose``
|
|
||||||
* ``plugin: pastebin``
|
|
||||||
* ``plugin: pytester``
|
|
||||||
* ``plugin: tmpdir``
|
|
||||||
* ``plugin: unittest``
|
|
||||||
* ``plugin: warnings``
|
|
||||||
* ``plugin: xdist``
|
|
||||||
|
|
||||||
|
|
||||||
**OS**
|
|
||||||
|
|
||||||
Issues specific to a single operating system. Do not use as a means to indicate where an issue originated from, only
|
|
||||||
for problems that happen **only** in that system.
|
|
||||||
|
|
||||||
* ``os: linux``
|
|
||||||
* ``os: mac``
|
|
||||||
* ``os: windows``
|
|
||||||
|
|
||||||
**Temporary**
|
|
||||||
|
|
||||||
Used to classify issues for limited time, to help find issues related in events for example.
|
|
||||||
They should be removed after they are no longer relevant.
|
|
||||||
|
|
||||||
* ``temporary: EP2017 sprint``:
|
|
||||||
* ``temporary: sprint-candidate``:
|
|
||||||
|
|
||||||
|
|
||||||
.. include:: ../../HOWTORELEASE.rst
|
.. include:: ../../HOWTORELEASE.rst
|
||||||
|
|
Loading…
Reference in New Issue