File: CONTRIBUTING.md

package info (click to toggle)
python-ddt 1.7.2-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 256 kB
  • sloc: python: 785; makefile: 147; sh: 11
file content (36 lines) | stat: -rw-r--r-- 886 bytes parent folder | download | duplicates (3)
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
# Contributing to DDT

## Guidelines

We'll be happy if you want to contribute to the improvement of `ddt`.

Code contributions will take the form of pull requests to
[the github repo](https://github.com/datadriventests/ddt).

Your PRs are more likely to be merged quickly if:

 - They adhere to coding conventions in the repo (PEP8)
 - They include tests

## Building

PRs to `ddt` are always built by Travis-CI on Python 2 and 3.

If you want to build `ddt` locally, the simplest way is to use `tox`:

```
pip install tox
tox
```

This will run tests on various releases of python (2 and 3, as long as they
are installed in your computer), run `flake8` and build the Sphinx
documentation.

Alternatively, if you only want to run tests on your active version of python,
I recommend you make yourself a virtual environment and:

```
pip install -r requirements/build.txt
./build.sh
```