From 72151f40247fce9bbdb7b877f01e32c15c784147 Mon Sep 17 00:00:00 2001 From: n1474335 Date: Thu, 8 Dec 2016 14:21:03 +0000 Subject: [PATCH] Created Contributing (markdown) --- Contributing.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 Contributing.md diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 0000000..861e0cc --- /dev/null +++ b/Contributing.md @@ -0,0 +1,18 @@ +There are lots of opportunities to contribute to CyberChef. If you want ideas, take a look at any [Issues](https://github.com/gchq/CyberChef/issues) tagged with 'help wanted'. + +Before your contributions can be accepted, you must: + + - Sign the [GCHQ Contributor Licence Agreement](https://github.com/gchq/Gaffer/wiki/GCHQ-OSS-Contributor-License-Agreement-V1.0) + - Push your changes to your fork. + - Submit a pull request. + + +## Coding conventions + +* Indentation: Each block should consist of 4 spaces +* Object/namespace identifiers: CamelCase +* Function/variable names: underscore_lower_case +* Constants: UNDERSCORE_UPPER_CASE +* Source code encoding: UTF-8 (without BOM) +* All source files must end with a newline +* Line endings: UNIX style (\n) \ No newline at end of file