Skip to content

Commit 09389d2

Browse files
committed
CONTRIBUTING.rst: spelling fixes
[ci skip]
1 parent d81ee9a commit 09389d2

File tree

1 file changed

+17
-22
lines changed

1 file changed

+17
-22
lines changed

CONTRIBUTING.rst

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ to fix the bug yet.
4848
Fix bugs
4949
--------
5050

51-
Look through the GitHub issues for bugs. Here is sample filter you can use:
51+
Look through the GitHub issues for bugs. Here is a filter you can use:
5252
https://github.com/pytest-dev/pytest/labels/bug
5353

5454
:ref:`Talk <contact>` to developers to find out how you can fix specific bugs.
@@ -60,8 +60,7 @@ Don't forget to check the issue trackers of your favourite plugins, too!
6060
Implement features
6161
------------------
6262

63-
Look through the GitHub issues for enhancements. Here is sample filter you
64-
can use:
63+
Look through the GitHub issues for enhancements. Here is a filter you can use:
6564
https://github.com/pytest-dev/pytest/labels/enhancement
6665

6766
:ref:`Talk <contact>` to developers to find out how you can implement specific
@@ -70,16 +69,15 @@ features.
7069
Write documentation
7170
-------------------
7271

73-
pytest could always use more documentation. What exactly is needed?
72+
Pytest could always use more documentation. What exactly is needed?
7473

7574
* More complementary documentation. Have you perhaps found something unclear?
7675
* Documentation translations. We currently have only English.
7776
* Docstrings. There can never be too many of them.
7877
* Blog posts, articles and such -- they're all very appreciated.
7978

80-
You can also edit documentation files directly in the Github web interface
81-
without needing to make a fork and local copy. This can be convenient for
82-
small fixes.
79+
You can also edit documentation files directly in the GitHub web interface,
80+
without using a local copy. This can be convenient for small fixes.
8381

8482

8583
.. _submitplugin:
@@ -95,13 +93,14 @@ in repositories living under the ``pytest-dev`` organisations:
9593
- `pytest-dev on Bitbucket <https://bitbucket.org/pytest-dev>`_
9694

9795
All pytest-dev Contributors team members have write access to all contained
98-
repositories. pytest core and plugins are generally developed
96+
repositories. Pytest core and plugins are generally developed
9997
using `pull requests`_ to respective repositories.
10098

10199
The objectives of the ``pytest-dev`` organisation are:
102100

103101
* Having a central location for popular pytest plugins
104-
* Sharing some of the maintenance responsibility (in case a maintainer no longer whishes to maintain a plugin)
102+
* Sharing some of the maintenance responsibility (in case a maintainer no
103+
longer wishes to maintain a plugin)
105104

106105
You can submit your plugin by subscribing to the `pytest-dev mail list
107106
<https://mail.python.org/mailman/listinfo/pytest-dev>`_ and writing a
@@ -159,15 +158,11 @@ As stated, the objective is to share maintenance and avoid "plugin-abandon".
159158
Preparing Pull Requests on GitHub
160159
---------------------------------
161160

162-
There's an excellent tutorial on how Pull Requests work in the
163-
`GitHub Help Center <https://help.github.com/articles/using-pull-requests/>`_
164-
165-
166161
.. note::
167162
What is a "pull request"? It informs project's core developers about the
168163
changes you want to review and merge. Pull requests are stored on
169164
`GitHub servers <https://github.com/pytest-dev/pytest/pulls>`_.
170-
Once you send pull request, we can discuss it's potential modifications and
165+
Once you send a pull request, we can discuss its potential modifications and
171166
even add more commits to it later on.
172167

173168
There's an excellent tutorial on how Pull Requests work in the
@@ -216,19 +211,19 @@ but here is a simple overview:
216211
This command will run tests via the "tox" tool against Python 2.7 and 3.5
217212
and also perform "lint" coding-style checks. ``runtox.py`` is
218213
a thin wrapper around ``tox`` which installs from a development package
219-
index where newer (not yet released to pypi) versions of dependencies
214+
index where newer (not yet released to PyPI) versions of dependencies
220215
(especially ``py``) might be present.
221216

222217
#. You can now edit your local working copy.
223218

224219
You can now make the changes you want and run the tests again as necessary.
225220

226-
To run tests on py27 and pass options to pytest (e.g. enter pdb on failure)
227-
to pytest you can do::
221+
To run tests on Python 2.7 and pass options to pytest (e.g. enter pdb on
222+
failure) to pytest you can do::
228223

229224
$ python3 runtox.py -e py27 -- --pdb
230225

231-
or to only run tests in a particular test module on py35::
226+
Or to only run tests in a particular test module on Python 3.5::
232227

233228
$ python3 runtox.py -e py35 -- testing/test_config.py
234229

@@ -237,9 +232,9 @@ but here is a simple overview:
237232
$ git commit -a -m "<commit message>"
238233
$ git push -u
239234

240-
Make sure you add a CHANGELOG message, and add yourself to AUTHORS. If you
241-
are unsure about either of these steps, submit your pull request and we'll
242-
help you fix it up.
235+
Make sure you add a message to ``CHANGELOG.rst`` and add yourself to
236+
``AUTHORS``. If you are unsure about either of these steps, submit your
237+
pull request and we'll help you fix it up.
243238

244239
#. Finally, submit a pull request through the GitHub website using this data::
245240

@@ -248,6 +243,6 @@ but here is a simple overview:
248243

249244
base-fork: pytest-dev/pytest
250245
base: master # if it's a bugfix
251-
base: feature # if it's a feature
246+
base: features # if it's a feature
252247

253248

0 commit comments

Comments
 (0)