diff options
author | Michael Boelen <michael.boelen@cisofy.com> | 2016-10-28 17:38:09 +0300 |
---|---|---|
committer | Michael Boelen <michael.boelen@cisofy.com> | 2016-10-28 17:38:09 +0300 |
commit | 54fac2141d533cd20c9a406e4bbd5fc4dd1afa00 (patch) | |
tree | 3e11f11509dcf3bbb0f51a41e7d84902b0cc04e0 /CONTRIBUTIONS.md | |
parent | 1cb1fc40ca5188dd3eef37c853fe3a76b22a37f7 (diff) |
Updated contributors guide
Diffstat (limited to 'CONTRIBUTIONS.md')
-rw-r--r-- | CONTRIBUTIONS.md | 67 |
1 files changed, 43 insertions, 24 deletions
diff --git a/CONTRIBUTIONS.md b/CONTRIBUTIONS.md index e3b17aa3..f31b9eb3 100644 --- a/CONTRIBUTIONS.md +++ b/CONTRIBUTIONS.md @@ -1,34 +1,19 @@ # Contributions -## Pull Requests -We welcome any contribution to improve Lynis. Contributions to the Lynis project can -be submitted as a pull request. The upstream project can be found in our [GitHub repository](https://github.com/CISOfy/lynis). - -By submitting a [Pull Request](https://help.github.com/articles/using-pull-requests/) -to this repository, you agree that you: - -1. Own the contribution that you are providing or have obtained permission from - the contribution owner - -2. Allow your contribution to be licensed under the license of the target - project (GPLv3) +## Helping out -3. Allow your contribution to be freely distributed to the Lynis community +### Run the latest version from GitHub +Run the tool in debug mode (use lynis audit system --profile developer.prf) and see if it shows any error. -4. Allow the project the [Unlimited Rights](#Unlimited-Rights) to your contribution +### Report bugs +Create an GitHub issue on the issue tracker -If you have questions regarding development, send us an e-mail at [lynis-dev](mailto:lynis-dev@cisofy.com) +### Suggest changes (pull request) +When you find something that can be improved, fork the project and create a pull request. -## Unlimited Rights -Our project is licensed under GPLv3. By providing a contribution to the project, it -will be used for the purpose of the project. Unlimited rights includes the rights to -use, modify, reproduce, release, perform, display, or disclose computer 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. +### Translations +See the db/languages directory -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, with optional the -company name and/or your e-mail address). ## Developer Guidelines @@ -37,6 +22,7 @@ To ensure all pull requests can be easily checked and merged, here are some tips * 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. + ## Code Guidelines ### General @@ -51,3 +37,36 @@ All functions use CamelCase to clearly show a difference between shell built-in ### Variables Variables should be capitalized, with underscore as word separator (e.g. PROCESS_EXISTS=1) + + +## Pull Requests +We welcome any contribution to improve Lynis. Contributions to the Lynis project can +be submitted as a pull request. The upstream project can be found in our [GitHub repository](https://github.com/CISOfy/lynis). + +By submitting a [Pull Request](https://help.github.com/articles/using-pull-requests/) +to this repository, you agree that you: + +1. Own the contribution that you are providing or have obtained permission from + the contribution owner + +2. Allow your contribution to be licensed under the license of the target + project (GPLv3) + +3. Allow your contribution to be freely distributed to the Lynis community + +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) + + +## Unlimited Rights +Our project is licensed under GPLv3. By providing a contribution to the project, +it will be used for the purpose of the project. Unlimited rights includes the +rights to use, modify, reproduce, release, perform, display, or disclose computer +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 +address). + |