File: HACKING.md

package info (click to toggle)
python-flanker 0.9.15-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 17,976 kB
  • sloc: python: 9,308; makefile: 4
file content (44 lines) | stat: -rw-r--r-- 1,337 bytes parent folder | download
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
Hacking
=======

### Installing

See the [Quickstart Guide](README.md) for instructions on how to install Flanker.

### Running Tests

Call `nosetests` in the `tests` directory to run unit tests. Note, some (network based) tests use `mock`.

```bash
$ cd ~/flanker/tests
$ nosetests
S..S..S..S..S..S.............................................SS................................................................................................................................................................
----------------------------------------------------------------------
Ran 223 tests in 2.256s

OK (SKIP=8)
````

Call with `--no-skip` to run all tests.

```bash
$ cd ~/flanker/tests
$ nosetests --no-skip
...............................................................................................................................................................................................................................
----------------------------------------------------------------------
Ran 223 tests in 7.806s

OK
```

### Discussion

Please use GitHub issues to discuss bugs, feature requests, and any other issues you may have with Flanker.

### Code Style Guidelines

Try to stick as close as possible to PEP8.

### Sending Pull Requests

Please ensure that any changes you make to Flanker are covered by tests.