about summary refs log tree commit diff
diff options
context:
space:
mode:
authorAndrea Fioraldi <andreafioraldi@gmail.com>2019-11-14 10:46:38 +0100
committerGitHub <noreply@github.com>2019-11-14 10:46:38 +0100
commita9972fe5594361a1e646296b5a183b474a7453cf (patch)
tree22c54cc2394cb3c4dc956615a2867faa9de1eec9
parent1f7f9fa9ecacf4c397bb2148f471632da16466bb (diff)
downloadafl++-a9972fe5594361a1e646296b5a183b474a7453cf.tar.gz
add notes about code style in contributing
-rw-r--r--CONTRIBUTING.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d6211ffd..03515c2d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -12,3 +12,8 @@ project, otherwise run:
 ```
 ./.custom-format.py -i file-that-you-have-created.c
 ```
+
+Regards the codyng style, please follow the AFL style.
+No camel case at all and use the AFL's macros when possible (e.g. WARNF, FATAL, ...).
+
+Remeber 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.