Add minor changes to CONTRIBUTE around coding styles
This commit is contained in:
parent
8757abe917
commit
ea8126c23e
19
CONTRIBUTE
19
CONTRIBUTE
|
@ -39,15 +39,16 @@ accept code without a proper header file.
|
||||||
We follow these simple rules:
|
We follow these simple rules:
|
||||||
|
|
||||||
* Make elisp linter happy
|
* Make elisp linter happy
|
||||||
* follow functional patterns and avoid huge functions
|
* Follow functional patterns and avoid huge functions
|
||||||
* seperate each expression by two new lines
|
* Seperate each root level expression by two new lines (e.g function definitions)
|
||||||
* put (comment ...) to demonstrate the usage of the function
|
* Put `(comment ...)` expression after each macro/function to demonstrate the usage.
|
||||||
* write good docstrings
|
* Write good docstrings
|
||||||
* choose meaningful names
|
* Choose meaningful names
|
||||||
* follow the indentation guides made in FG42
|
* Follow the indentation guides made in FG42
|
||||||
* prefix the functions with a prefix to differentiate them from other functions ( we need to discuss this)
|
* Prefix the functions with a prefix to differentiate them from other functions.
|
||||||
* use <prefix>--<fn-name> for private/internal function names
|
for example `fg42-namespace/functoin-name`.
|
||||||
* use / to categorize functions into namespaces ( air quote)
|
* use `<prefix>/-<fn-name>` for private/internal function names
|
||||||
|
* use `/` to categorize functions into namespaces (air quote)
|
||||||
|
|
||||||
#### Pull-Request
|
#### Pull-Request
|
||||||
Submit your contribution against the `master` branch. The `stable` branch
|
Submit your contribution against the `master` branch. The `stable` branch
|
||||||
|
|
Loading…
Reference in New Issue