diff options
| author | Michael Boelen <michael.boelen@cisofy.com> | 2016-05-02 18:12:19 +0300 |
|---|---|---|
| committer | Michael Boelen <michael.boelen@cisofy.com> | 2016-05-02 18:12:19 +0300 |
| commit | ee4bd4cb263d97f53a299dfb01e4cd07ffce11a8 (patch) | |
| tree | 8601571a7422032b0c8e014db26c4273710e5006 /CONTRIBUTIONS.md | |
| parent | 6ea27b912c4c2e29d190799be4df8eff56b6fe24 (diff) | |
Added more guidelines for submitting patches
Diffstat (limited to 'CONTRIBUTIONS.md')
| -rw-r--r-- | CONTRIBUTIONS.md | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/CONTRIBUTIONS.md b/CONTRIBUTIONS.md index dd032453..e3b17aa3 100644 --- a/CONTRIBUTIONS.md +++ b/CONTRIBUTIONS.md @@ -36,4 +36,18 @@ To ensure all pull requests can be easily checked and merged, here are some tips * Your code should work on other platforms running the bourne shell (/bin/sh), not just BASH. * Properly document your code where needed. Besides the 'what', focus on explaining the 'why'. * Check the log information (lynis.log) of your new test or changed code, so that it provides helpful details for others. -* Most variables should be capitalized, with underscore as word separator (e.g. PROCESS_EXISTS=1) + +## Code Guidelines + +### General +Identation should be 4 spaces (no tab character). + +### Comments +Comments: use # sign followed by a space. When needed, create a comment block. +Blank lines: allowed, one line maximum + +### Functions +All functions use CamelCase to clearly show a difference between shell built-in commands, or external commands. + +### Variables +Variables should be capitalized, with underscore as word separator (e.g. PROCESS_EXISTS=1) |