aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: ccacef5f6514235dc91c09de8a815efc14509b2e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# How to submit a Pull Request to AFLplusplus

All contributions (pull requests) must be made against our `dev` branch.

Each modified source file, before merging, must be formatted.

```
make code-format
```

This should be fine if you modified one of the files already present in the
project, or added a file in a directory we already format, otherwise run:

```
./.custom-format.py -i file-that-you-have-created.c
```

Regarding the coding style, please follow the AFL style.
No camel case at all and use the AFL's macros wherever possible 
(e.g. WARNF, FATAL, MAP_SIZE, ...).

Remember that AFLplusplus has to build and run on many platforms, so
generalize your Makefiles/GNUmakefile (or your patches to our pre-existing
Makefiles) to be as much generic as possible.