From ea8126c23e17251afdf35710fafea35632fdf9ce Mon Sep 17 00:00:00 2001 From: Sameer Rahmani Date: Tue, 14 Apr 2020 22:40:40 +0100 Subject: [PATCH] Add minor changes to CONTRIBUTE around coding styles --- CONTRIBUTE | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTE b/CONTRIBUTE index d7dd651..7977911 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE @@ -39,15 +39,16 @@ accept code without a proper header file. We follow these simple rules: * Make elisp linter happy -* follow functional patterns and avoid huge functions -* seperate each expression by two new lines -* put (comment ...) to demonstrate the usage of the function -* write good docstrings -* choose meaningful names -* follow the indentation guides made in FG42 -* prefix the functions with a prefix to differentiate them from other functions ( we need to discuss this) -* use -- for private/internal function names -* use / to categorize functions into namespaces ( air quote) +* Follow functional patterns and avoid huge functions +* Seperate each root level expression by two new lines (e.g function definitions) +* Put `(comment ...)` expression after each macro/function to demonstrate the usage. +* Write good docstrings +* Choose meaningful names +* Follow the indentation guides made in FG42 +* Prefix the functions with a prefix to differentiate them from other functions. + for example `fg42-namespace/functoin-name`. +* use `/-` for private/internal function names +* use `/` to categorize functions into namespaces (air quote) #### Pull-Request Submit your contribution against the `master` branch. The `stable` branch