Skip to content

Commit 144dc12

Browse files
authored
Merge pull request #1638 from blueyed/fix-CONTRIBUTING
CONTRIBUTING.rst: spelling fixes
2 parents c3ee1c1 + 09389d2 commit 144dc12

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
@@ -150,15 +149,11 @@ As stated, the objective is to share maintenance and avoid "plugin-abandon".
150149
Preparing Pull Requests on GitHub
151150
---------------------------------
152151

153-
There's an excellent tutorial on how Pull Requests work in the
154-
`GitHub Help Center <https://help.github.com/articles/using-pull-requests/>`_
155-
156-
157152
.. note::
158153
What is a "pull request"? It informs project's core developers about the
159154
changes you want to review and merge. Pull requests are stored on
160155
`GitHub servers <https://github.com/pytest-dev/pytest/pulls>`_.
161-
Once you send pull request, we can discuss it's potential modifications and
156+
Once you send a pull request, we can discuss its potential modifications and
162157
even add more commits to it later on.
163158

164159
There's an excellent tutorial on how Pull Requests work in the
@@ -207,19 +202,19 @@ but here is a simple overview:
207202
This command will run tests via the "tox" tool against Python 2.7 and 3.5
208203
and also perform "lint" coding-style checks. ``runtox.py`` is
209204
a thin wrapper around ``tox`` which installs from a development package
210-
index where newer (not yet released to pypi) versions of dependencies
205+
index where newer (not yet released to PyPI) versions of dependencies
211206
(especially ``py``) might be present.
212207

213208
#. You can now edit your local working copy.
214209

215210
You can now make the changes you want and run the tests again as necessary.
216211

217-
To run tests on py27 and pass options to pytest (e.g. enter pdb on failure)
218-
to pytest you can do::
212+
To run tests on Python 2.7 and pass options to pytest (e.g. enter pdb on
213+
failure) to pytest you can do::
219214

220215
$ python3 runtox.py -e py27 -- --pdb
221216

222-
or to only run tests in a particular test module on py35::
217+
Or to only run tests in a particular test module on Python 3.5::
223218

224219
$ python3 runtox.py -e py35 -- testing/test_config.py
225220

@@ -228,9 +223,9 @@ but here is a simple overview:
228223
$ git commit -a -m "<commit message>"
229224
$ git push -u
230225

231-
Make sure you add a CHANGELOG message, and add yourself to AUTHORS. If you
232-
are unsure about either of these steps, submit your pull request and we'll
233-
help you fix it up.
226+
Make sure you add a message to ``CHANGELOG.rst`` and add yourself to
227+
``AUTHORS``. If you are unsure about either of these steps, submit your
228+
pull request and we'll help you fix it up.
234229

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

@@ -239,6 +234,6 @@ but here is a simple overview:
239234

240235
base-fork: pytest-dev/pytest
241236
base: master # if it's a bugfix
242-
base: feature # if it's a feature
237+
base: features # if it's a feature
243238

244239

0 commit comments

Comments
 (0)