1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
Contributing
============
We welcome contributions via GitHub pull requests:
- `Fork a Repo <https://help.github.com/articles/fork-a-repo/>`_
- `Creating a pull request
<https://help.github.com/articles/creating-a-pull-request/>`_
Developing
----------
Prepare a developer environment. Then, from the blessed code folder::
pip install --editable .
Any changes made in this project folder are then made available to the python
interpreter as the 'blessed' package from any working directory.
Running Tests
~~~~~~~~~~~~~
Install and run tox
::
pip install --upgrade tox
tox
Py.test is used as the test runner, supporting positional arguments, you may
for example use `looponfailing
<https://pytest.org/latest/xdist.html#running-tests-in-looponfailing-mode>`_
with python 3.5, stopping at the first failing test case, and looping
(retrying) after a filesystem save is detected::
tox -epy35 -- -fx
The test runner (``tox``) ensures all code and documentation complies with
standard python style guides, pep8 and pep257, as well as various static
analysis tools.
Test Coverage
~~~~~~~~~~~~~
When you contribute a new feature, make sure it is covered by tests.
Likewise, a bug fix should include a test demonstrating the bug.
|
