diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f31b9eb3..5d9d4b00 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,4 @@ + # Contributions ## Helping out @@ -6,13 +7,13 @@ Run the tool in debug mode (use lynis audit system --profile developer.prf) and see if it shows any error. ### Report bugs -Create an GitHub issue on the issue tracker +Create a GitHub issue on the issue tracker. ### Suggest changes (pull request) When you find something that can be improved, fork the project and create a pull request. ### Translations -See the db/languages directory +See the db/languages directory. ## Developer Guidelines @@ -26,17 +27,17 @@ To ensure all pull requests can be easily checked and merged, here are some tips ## Code Guidelines ### General -Identation should be 4 spaces (no tab character). +Indentation 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 +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) +Variables should be capitalized, with underscore as word separator (e.g. PROCESS_EXISTS=1). ## Pull Requests @@ -56,7 +57,7 @@ to this repository, you agree that you: 4. Allow the project the [Unlimited Rights](#Unlimited-Rights) to your contribution -If you have questions regarding development, send us an e-mail at [lynis-dev](mailto:lynis-dev@cisofy.com) +If you have questions regarding development, send us an e-mail at [lynis-dev](mailto:lynis-dev@cisofy.com). ## Unlimited Rights @@ -67,6 +68,6 @@ software or computer software documentation in whole or in part, in any manner and for any purpose whatsoever, and to have or authorize others to do so. If you want to be named in as a contributor in the CONTRIBUTOR file, then include -this notition in your pull request. Preferred format: Full Name, and your e-mail +this notation in your pull request. Preferred format: Full Name, and your e-mail address). |