File: CONTRIBUTING.md

package info (click to toggle)
debian-codemods 0.174
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 12,588 kB
  • sloc: makefile: 900; xml: 119; python: 80; sh: 71; javascript: 3
file content (48 lines) | stat: -rw-r--r-- 873 bytes parent folder | download | duplicates (2)
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
48
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 fixers are written in Rust.

Code style can be checked by running ``cargo clippy``:

```shell
cargo clippy
```

Code can be formatted with ``cargo fmt``:

```shell
cargo fmt
```

Tests
-----

To run the testsuite, use:

```shell
make check
```

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

```shell
cargo test fixer_name
```

(with any dashes in the fixer name replaced by underscores).

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