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

Revisit CONTRIBUTING.rst

This commit is contained in:
Daniel Hahler 2017-07-25 18:27:26 +02:00
parent 71947cb4f0
commit 949a1406f0
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
CONTRIBUTING.rst
View File

@ -34,13 +34,13 @@ If you are reporting a bug, please include:
* Your operating system name and version. * Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting, * Any details about your local setup that might be helpful in troubleshooting,
specifically Python interpreter version, specifically the Python interpreter version, installed libraries, and pytest
installed libraries and pytest version. version.
* Detailed steps to reproduce the bug. * Detailed steps to reproduce the bug.
If you can write a demonstration test that currently fails but should pass (xfail), If you can write a demonstration test that currently fails but should pass
that is a very useful commit to make as well, even if you can't find how (xfail), that is a very useful commit to make as well, even if you cannot
to fix the bug yet. fix the bug itself.
.. _fixbugs: .. _fixbugs:
@ -165,29 +165,30 @@ Short version
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
#. Fork the repository; #. Fork the repository;
#. Target ``master`` for bug-fix and doc changes; #. Target ``master`` for bugfixes and doc changes;
#. Target ``features`` for new features or functionality changes. #. Target ``features`` for new features or functionality changes.
#. Follow **PEP-8**. There's a ``tox`` command to help fixing it: ``tox -e fix-lint``. #. Follow **PEP-8**. There's a ``tox`` command to help fixing it: ``tox -e fix-lint``.
#. Tests are run using ``tox``:: #. Tests are run using ``tox``::
tox -e linting,py27,py36 tox -e linting,py27,py36
The test environments above are usually enough to to cover most cases locally. The test environments above are usually enough to cover most cases locally.
#. Write a ``changelog`` entry: ``changelog/2574.bugfix``, use issue id number and one of #. Write a ``changelog`` entry: ``changelog/2574.bugfix``, use issue id number
``bugfix``, ``removal``, ``feature``, ``vendor``, ``doc`` or ``trivial`` for the issue type. and one of ``bugfix``, ``removal``, ``feature``, ``vendor``, ``doc`` or
``trivial`` for the issue type.
#. Add yourself to ``AUTHORS`` file if not there yet, in alphabetical order. #. Add yourself to ``AUTHORS`` file if not there yet, in alphabetical order.
Long version Long version
~~~~~~~~~~~~ ~~~~~~~~~~~~
What is a "pull request"? It informs the project's core developers about the
What is a "pull request"? It informs project's core developers about the
changes you want to review and merge. Pull requests are stored on changes you want to review and merge. Pull requests are stored on
`GitHub servers <https://github.com/pytest-dev/pytest/pulls>`_. `GitHub servers <https://github.com/pytest-dev/pytest/pulls>`_.
Once you send a pull request, we can discuss its potential modifications and Once you send a pull request, we can discuss its potential modifications and
even add more commits to it later on. There's an excellent tutorial on how Pull Requests work in the even add more commits to it later on. There's an excellent tutorial on how Pull
Requests work in the
`GitHub Help Center <https://help.github.com/articles/using-pull-requests/>`_. `GitHub Help Center <https://help.github.com/articles/using-pull-requests/>`_.
Here is a simple overview, with pytest-specific bits: Here is a simple overview, with pytest-specific bits: