@@ -48,7 +48,7 @@ to fix the bug yet.
48
48
Fix bugs
49
49
--------
50
50
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:
52
52
https://github.com/pytest-dev/pytest/labels/bug
53
53
54
54
: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!
60
60
Implement features
61
61
------------------
62
62
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:
65
64
https://github.com/pytest-dev/pytest/labels/enhancement
66
65
67
66
:ref: `Talk <contact >` to developers to find out how you can implement specific
@@ -70,16 +69,15 @@ features.
70
69
Write documentation
71
70
-------------------
72
71
73
- pytest could always use more documentation. What exactly is needed?
72
+ Pytest could always use more documentation. What exactly is needed?
74
73
75
74
* More complementary documentation. Have you perhaps found something unclear?
76
75
* Documentation translations. We currently have only English.
77
76
* Docstrings. There can never be too many of them.
78
77
* Blog posts, articles and such -- they're all very appreciated.
79
78
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.
83
81
84
82
85
83
.. _submitplugin :
@@ -95,13 +93,14 @@ in repositories living under the ``pytest-dev`` organisations:
95
93
- `pytest-dev on Bitbucket <https://bitbucket.org/pytest-dev >`_
96
94
97
95
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
99
97
using `pull requests `_ to respective repositories.
100
98
101
99
The objectives of the ``pytest-dev `` organisation are:
102
100
103
101
* 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)
105
104
106
105
You can submit your plugin by subscribing to the `pytest-dev mail list
107
106
<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".
150
149
Preparing Pull Requests on GitHub
151
150
---------------------------------
152
151
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
-
157
152
.. note ::
158
153
What is a "pull request"? It informs project's core developers about the
159
154
changes you want to review and merge. Pull requests are stored on
160
155
`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
162
157
even add more commits to it later on.
163
158
164
159
There's an excellent tutorial on how Pull Requests work in the
@@ -207,19 +202,19 @@ but here is a simple overview:
207
202
This command will run tests via the "tox" tool against Python 2.7 and 3.5
208
203
and also perform "lint" coding-style checks. ``runtox.py `` is
209
204
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
211
206
(especially ``py ``) might be present.
212
207
213
208
#. You can now edit your local working copy.
214
209
215
210
You can now make the changes you want and run the tests again as necessary.
216
211
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::
219
214
220
215
$ python3 runtox.py -e py27 -- --pdb
221
216
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 ::
223
218
224
219
$ python3 runtox.py -e py35 -- testing/test_config.py
225
220
@@ -228,9 +223,9 @@ but here is a simple overview:
228
223
$ git commit -a -m "<commit message>"
229
224
$ git push -u
230
225
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.
234
229
235
230
#. Finally, submit a pull request through the GitHub website using this data::
236
231
@@ -239,6 +234,6 @@ but here is a simple overview:
239
234
240
235
base-fork: pytest-dev/pytest
241
236
base: master # if it's a bugfix
242
- base: feature # if it's a feature
237
+ base: features # if it's a feature
243
238
244
239
0 commit comments