File: CONTRIBUTING.md

package info (click to toggle)
lintian-brush 0.147
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 9,872 kB
  • sloc: python: 17,649; makefile: 814; sh: 140; xml: 119; javascript: 3; ansic: 2
file content (46 lines) | stat: -rw-r--r-- 833 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
45
46
Contributing
============

Philosophy
----------

The fixers in lintian-brush should be as simple as possible. They don't have to
deal with version control, and can just give up and have their changes reverted
for them (by exiting with a non-zero exit code).

Fixers should be as fast as possible when they do not find anything to fix, since
this is the common case.

Coding Style
------------

lintian-brush uses PEP8 as its coding style.

Code style can be checked by running ``flake8``:

```shell
flake8
```

Tests
-----

To run the testsuite, use:

```shell
python3 -m unittest lintian_brush.tests.test_suite
```

or simply:

```shell
make check
```

To run the tests for a specific-fixer, run something like:

```shell
make check-fixer-ancient-maintscript-entry
```

The tests are also run by the package build and autopkgtest.