2019-09-03 11:19:27 +02:00
|
|
|
# How to submit a Pull Request to AFLplusplus
|
|
|
|
|
|
2020-07-28 13:29:50 +02:00
|
|
|
All contributions (pull requests) must be made against our `dev` branch.
|
|
|
|
|
|
2019-09-03 11:19:27 +02:00
|
|
|
Each modified source file, before merging, must be formatted.
|
|
|
|
|
|
|
|
|
|
```
|
2020-02-28 10:23:23 +01:00
|
|
|
make code-format
|
2019-09-03 11:19:27 +02:00
|
|
|
```
|
|
|
|
|
|
2019-11-15 11:26:10 +01:00
|
|
|
This should be fine if you modified one of the files already present in the
|
2020-02-28 10:23:23 +01:00
|
|
|
project, or added a file in a directory we already format, otherwise run:
|
2019-09-03 11:19:27 +02:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
./.custom-format.py -i file-that-you-have-created.c
|
|
|
|
|
```
|
2019-11-14 10:46:38 +01:00
|
|
|
|
2019-11-15 11:26:10 +01:00
|
|
|
Regarding the coding style, please follow the AFL style.
|
2020-02-28 10:23:23 +01:00
|
|
|
No camel case at all and use the AFL's macros wherever possible
|
|
|
|
|
(e.g. WARNF, FATAL, MAP_SIZE, ...).
|
2019-11-14 10:46:38 +01:00
|
|
|
|
2020-02-28 10:23:23 +01:00
|
|
|
Remember that AFLplusplus has to build and run on many platforms, so
|
2020-07-28 13:29:50 +02:00
|
|
|
generalize your Makefiles/GNUmakefile (or your patches to our pre-existing
|
|
|
|
|
Makefiles) to be as much generic as possible.
|
