p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Small fixes to development_guide: title and label names 

* Fix title to use a proper "title" section marker
* Fix labels by adding a " " after the ":"
* Fix OS labels after obvious mishap
* Sort labels
This commit is contained in:
Bruno Oliveira 2017-09-14 19:37:08 -03:00
parent 25d2acbdb2
commit 810320f591
1 changed files with 26 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
doc/en/development_guide.rst
View File

@ -1,5 +1,6 @@
=================
Development Guide
-----------------
=================
Some general guidelines regarding development in pytest for core maintainers and general contributors. Nothing here
is set in stone and can't be changed, feel free to suggest improvements or changes in the workflow.
@ -41,42 +42,46 @@ Here is a list of labels and a brief description mentioning their intent.
**Type**
* ``type:bug``: problem that needs to be addressed.
* ``type:backward compatibility``: issue that will cause problems with old pytest versions.
* ``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.
* ``type: backward compatibility``: issue that will cause problems with old pytest versions.
* ``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**
* ``status:critical``: grave problem or usability issue that affects lots of users.
* ``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.
* ``status: critical``: grave problem or usability issue that affects lots of users.
* ``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: selection``
* ``topic: reporting``
* ``topic: selection``
* ``topic: tracebacks``
**Plugin (internal or external)**
* ``plugin: junitxml``
* ``plugin: cache``
* ``plugin: capture``
* ``plugin: doctests``
* ``plugin: junitxml``
* ``plugin: monkeypatch``
* ``plugin: nose``
* ``plugin: pastebin``
* ``plugin: pytester``
* ``plugin: tmpdir``
* ``plugin: unittest``
* ``plugin: warnings``
* ``plugin: xdist``
@ -87,9 +92,9 @@ Here is a list of labels and a brief description mentioning their intent.
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``
* ``linux: windows``
* ``mac: windows``
**Temporary**