mirrors/prezto
1
0
Fork 1
mirror of https://github.com/sorin-ionescu/prezto.git synced 2024-05-16 14:51:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add code style to CONTRIBUTING.md

Browse source 
Closes #1296
This commit is contained in:
Kaleb Elwert 2017-04-15 01:14:09 -07:00
parent e606b09c9e
commit 19d11ab1d0
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.md
View file

@ -23,6 +23,17 @@ improve its performance, do not hesitate to fork and send pull requests.
- Open a [pull request][4] that relates to but one subject with a clear
title and description in grammatically correct, complete sentences.
#### Code Style
- Indent using 2 spaces. No tabs.
- Put `; do` and `; then` on the same line as the `while`, `for` or `if`.
- Local variables should be used whenever possible.
- Use `snake_case` for variable and function naming.
- Local variables should be lower cased.
- Global variables should be upper cased.
- Use `$(command)` instead of backticks.
- Avoid `eval` if possible.
#### Modules
- A *README.md* must be present.