Skip to content

Commit 55576a0

Browse files
authored
Update new reactor contribution instructions
1 parent d1c02e2 commit 55576a0

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

Diff for: CONTRIBUTING.rst

+14-3
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,26 @@ What it takes to add a new reactor:
88

99
* In ``testing/test_basic.py``
1010

11-
* Add ``test_blockon_in_hook_with_foo()`` decorated by ``@skip_if_reactor_not('foo')``
12-
* Add ``test_wrong_reactor_with_foo()`` decorated by ``@skip_if_reactor_not('foo')``
11+
* Add ``test_blockon_in_hook_with_foo()`` with ``skip_if_reactor_not('foo')`` as the first line
12+
* Add ``test_wrong_reactor_with_foo()`` with ``skip_if_reactor_not('foo')`` as the first line
1313

1414
* In ``tox.ini``
1515

1616
* Adjust ``envlist`` to include the ``fooreactor`` factor for the appropriate versions of Python
1717
* Add conditional ``deps`` for the new reactor such as ``foo: foobar`` to the appropriate test environments
18-
* Add the conditional assignment ``foo: reactor_option=foo`` to ``setenv`` in the appropriate test environments
18+
* Add ``fooreactor: pytest --reactor=foo`` to the commands list
1919

2020
* In ``.travis.yml``
2121

2222
* Consider any extra system packages which may be required
23+
24+
* In ``appveyor.yml``
25+
26+
* Add the new reactor environment to the ``TOXENV`` for each relevant Python
27+
28+
Reference reactor additions:
29+
* `asyncio`_
30+
* `qt5reactor`_
31+
32+
.. _`asyncio`: https://github.com/pytest-dev/pytest-twisted/pull/63
33+
.. _`qt5reactor`: https://github.com/pytest-dev/pytest-twisted/pull/16

0 commit comments

Comments
 (0)