tyler.durden/lynis
1
0
Fork 0
mirror of https://github.com/CISOfy/lynis.git synced 2025-07-31 01:34:23 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated Developer Guide (markdown)

Michael Boelen 2015-09-14 14:09:36 +02:00
parent 1dac16a3e7
commit 1dc5237ee2
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
Developer-Guide.md

@ -22,4 +22,25 @@ Supporting documents and scripts are stored here.
Like any programming language, there are different ways to keep a project structured. It ranges from variable names, up to spacing. So we provide some guidelines to keep the structure and flexible enough for further expansion.
* Identitation is done with 4 spaces (no tabs)
* Variables are capitalized, optional with an underscore to "split" words
* Variables are capitalized, optional with an underscore to "split" words
# Contribute
## Preparing
If you use Git already, simply clone the project to your local system. Otherwise work with a local copy. At the GitHub page you can download the master.zip file, containing the latest master release.
## Making changes
Next step is making your local changes and test them.
**Tip:** To simplify testing, you don't have Lynis to perform all tests. Use --tests-category or --tests to specifically decide what tests to run.
## Testing your changes
To improve the quality of your changes, tests should limit the amount of screen output. Important details should be logged to the log file, using the `logtext` function.
## Send in your changes
Last step is creating a pull request. Provide a clear description on what the pull request is about (and why). If you have multiple changes to different tests, split them into multiple pull requests. This way it is easier to check and implement them in the master branch.