From e377b87ff717dd4cc3b1e50d411b00c3fb570eed Mon Sep 17 00:00:00 2001 From: Diogo Cordeiro Date: Sun, 22 Jul 2018 23:41:08 +0000 Subject: [PATCH] Add Project's Coding Style --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a470697..46f6138 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,8 +5,10 @@ email, or any other method with the owners of this repository before making a ch Please note we have a code of conduct, please follow it in all your interactions with the project. -# Indentation Style -We are using [K&R Variant: Linux kernel](https://en.wikipedia.org/wiki/Indentation_style#Variant:_Linux_kernel) with spaces before every `(`. +# Coding Style +- We are using [K&R Variant: Linux kernel](https://en.wikipedia.org/wiki/Indentation_style#Variant:_Linux_kernel) with spaces before every `(`. +- Every function has a docblock explaining what it does and stating the author, parameters, types, return and exceptions +- We use snake_case ## Pull Request Process