@@ -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
@@ -127,27 +126,18 @@ transferred to the ``pytest-dev`` organisation.
127
126
Here's a rundown of how a repository transfer usually proceeds
128
127
(using a repository named ``joedoe/pytest-xyz `` as example):
129
128
130
- * One of the ``pytest-dev `` administrators creates:
131
-
132
- - ``pytest-xyz-admin `` team, with full administration rights to
133
- ``pytest-dev/pytest-xyz ``.
134
- - ``pytest-xyz-developers `` team, with write access to
135
- ``pytest-dev/pytest-xyz ``.
136
-
137
- * ``joedoe `` is invited to the ``pytest-xyz-admin `` team;
138
-
139
- * After accepting the invitation, ``joedoe `` transfers the repository from its
140
- original location to ``pytest-dev/pytest-xyz `` (A nice feature is that GitHub handles URL redirection from
141
- the old to the new location automatically).
142
-
143
- * ``joedoe `` is free to add any other collaborators to the
144
- ``pytest-xyz-admin `` or ``pytest-xyz-developers `` team as desired.
129
+ * ``joedoe `` transfers repository ownership to ``pytest-dev `` administrator ``calvin ``.
130
+ * ``calvin `` creates ``pytest-xyz-admin `` and ``pytest-xyz-developers `` teams, inviting ``joedoe `` to both as **maintainer **.
131
+ * ``calvin `` transfers repository to ``pytest-dev `` and configures team access:
132
+
133
+ - ``pytest-xyz-admin `` **admin ** access;
134
+ - ``pytest-xyz-developers `` **write ** access;
145
135
146
136
The ``pytest-dev/Contributors `` team has write access to all projects, and
147
137
every project administrator is in it. We recommend that each plugin has at least three
148
138
people who have the right to release to PyPI.
149
139
150
- Repository owners can be assured that no ``pytest-dev `` administrator will ever make
140
+ Repository owners can rest assured that no ``pytest-dev `` administrator will ever make
151
141
releases of your repository or take ownership in any way, except in rare cases
152
142
where someone becomes unresponsive after months of contact attempts.
153
143
As stated, the objective is to share maintenance and avoid "plugin-abandon".
@@ -159,15 +149,11 @@ As stated, the objective is to share maintenance and avoid "plugin-abandon".
159
149
Preparing Pull Requests on GitHub
160
150
---------------------------------
161
151
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
-
166
152
.. note ::
167
153
What is a "pull request"? It informs project's core developers about the
168
154
changes you want to review and merge. Pull requests are stored on
169
155
`GitHub servers <https://github.com/pytest-dev/pytest/pulls >`_.
170
- 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
171
157
even add more commits to it later on.
172
158
173
159
There's an excellent tutorial on how Pull Requests work in the
@@ -216,19 +202,19 @@ but here is a simple overview:
216
202
This command will run tests via the "tox" tool against Python 2.7 and 3.5
217
203
and also perform "lint" coding-style checks. ``runtox.py `` is
218
204
a thin wrapper around ``tox `` which installs from a development package
219
- index where newer (not yet released to pypi ) versions of dependencies
205
+ index where newer (not yet released to PyPI ) versions of dependencies
220
206
(especially ``py ``) might be present.
221
207
222
208
#. You can now edit your local working copy.
223
209
224
210
You can now make the changes you want and run the tests again as necessary.
225
211
226
- To run tests on py27 and pass options to pytest (e.g. enter pdb on failure)
227
- 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::
228
214
229
215
$ python3 runtox.py -e py27 -- --pdb
230
216
231
- 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 ::
232
218
233
219
$ python3 runtox.py -e py35 -- testing/test_config.py
234
220
@@ -237,9 +223,9 @@ but here is a simple overview:
237
223
$ git commit -a -m "<commit message>"
238
224
$ git push -u
239
225
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.
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.
243
229
244
230
#. Finally, submit a pull request through the GitHub website using this data::
245
231
@@ -248,6 +234,6 @@ but here is a simple overview:
248
234
249
235
base-fork: pytest-dev/pytest
250
236
base: master # if it's a bugfix
251
- base: feature # if it's a feature
237
+ base: features # if it's a feature
252
238
253
239
0 commit comments