Skip to content

Commit 79097e8

Browse files
authored
Merge pull request #2615 from blueyed/revisit_contributing.rst
Revisit CONTRIBUTING.rst
2 parents 1a42e26 + 949a140 commit 79097e8

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

CONTRIBUTING.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ If you are reporting a bug, please include:
3434

3535
* Your operating system name and version.
3636
* Any details about your local setup that might be helpful in troubleshooting,
37-
specifically Python interpreter version,
38-
installed libraries and pytest version.
37+
specifically the Python interpreter version, installed libraries, and pytest
38+
version.
3939
* Detailed steps to reproduce the bug.
4040

41-
If you can write a demonstration test that currently fails but should pass (xfail),
42-
that is a very useful commit to make as well, even if you can't find how
43-
to fix the bug yet.
41+
If you can write a demonstration test that currently fails but should pass
42+
(xfail), that is a very useful commit to make as well, even if you cannot
43+
fix the bug itself.
4444

4545

4646
.. _fixbugs:
@@ -165,29 +165,30 @@ Short version
165165
~~~~~~~~~~~~~
166166

167167
#. Fork the repository;
168-
#. Target ``master`` for bug-fix and doc changes;
168+
#. Target ``master`` for bugfixes and doc changes;
169169
#. Target ``features`` for new features or functionality changes.
170170
#. Follow **PEP-8**. There's a ``tox`` command to help fixing it: ``tox -e fix-lint``.
171171
#. Tests are run using ``tox``::
172172

173173
tox -e linting,py27,py36
174174

175-
The test environments above are usually enough to to cover most cases locally.
175+
The test environments above are usually enough to cover most cases locally.
176176

177-
#. Write a ``changelog`` entry: ``changelog/2574.bugfix``, use issue id number and one of
178-
``bugfix``, ``removal``, ``feature``, ``vendor``, ``doc`` or ``trivial`` for the issue type.
177+
#. Write a ``changelog`` entry: ``changelog/2574.bugfix``, use issue id number
178+
and one of ``bugfix``, ``removal``, ``feature``, ``vendor``, ``doc`` or
179+
``trivial`` for the issue type.
179180
#. Add yourself to ``AUTHORS`` file if not there yet, in alphabetical order.
180181

181182

182183
Long version
183184
~~~~~~~~~~~~
184185

185-
186-
What is a "pull request"? It informs project's core developers about the
186+
What is a "pull request"? It informs the project's core developers about the
187187
changes you want to review and merge. Pull requests are stored on
188188
`GitHub servers <https://github.com/pytest-dev/pytest/pulls>`_.
189189
Once you send a pull request, we can discuss its potential modifications and
190-
even add more commits to it later on. There's an excellent tutorial on how Pull Requests work in the
190+
even add more commits to it later on. There's an excellent tutorial on how Pull
191+
Requests work in the
191192
`GitHub Help Center <https://help.github.com/articles/using-pull-requests/>`_.
192193

193194
Here is a simple overview, with pytest-specific bits:

0 commit comments

Comments
 (0)