diff options
| author | van Hauser <vh@thc.org> | 2020-02-28 10:23:23 +0100 |
|---|---|---|
| committer | van Hauser <vh@thc.org> | 2020-02-28 10:23:23 +0100 |
| commit | 57495a794dab13c2a6a19a4adf7275c3eb76c185 (patch) | |
| tree | 8fe4d92ce944fb433f8de709c45f71b29ce2ad53 | |
| parent | 7d0ae2939d8de880578ba088ec9892ce268237d0 (diff) | |
| download | afl++-57495a794dab13c2a6a19a4adf7275c3eb76c185.tar.gz | |
updated contribution info
| -rw-r--r-- | CONTRIBUTING.md | 11 | ||||
| -rw-r--r-- | README.md | 3 |
2 files changed, 10 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 491bb84f..90049432 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,17 +3,20 @@ Each modified source file, before merging, must be formatted. ``` -make code-formatter +make code-format ``` This should be fine if you modified one of the files already present in the -project, otherwise run: +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 when possible (e.g. WARNF, FATAL, ...). +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 (or your patches to our pre-existing Makefiles) to be as much general as possible. +Remember that AFLplusplus has to build and run on many platforms, so +generalize your Makefiles (or your patches to our pre-existing Makefiles) +to be as much generic as possible. diff --git a/README.md b/README.md index 275373fd..7396706c 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,9 @@ something cool We have an idea list in [docs/ideas.md](docs/ideas.md) +For everyone who wants to contribute (and send pull requests) please read +[CONTRIBUTING.md](CONTRIBUTING.md) before your submit. + ## 0) Building and installing afl++ afl++ has many build options. |