mirror of https://github.com/CISOfy/lynis.git
Added some guidelines for pull requests
This commit is contained in:
parent
4a354c8479
commit
98de52e0f8
|
@ -1,8 +1,8 @@
|
||||||
# Contributions
|
# Contributions
|
||||||
|
|
||||||
## Pull Requests
|
## Pull Requests
|
||||||
Contributions to the Lynis project should be submitted as a pull request. The upstream
|
We welcome any contribution to improve Lynis. Contributions to the Lynis project can
|
||||||
project can be found in our [GitHub repository](https://github.com/CISOfy/lynis).
|
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/)
|
By submitting a [Pull Request](https://help.github.com/articles/using-pull-requests/)
|
||||||
to this repository, you agree that you:
|
to this repository, you agree that you:
|
||||||
|
@ -17,6 +17,7 @@ to this repository, you agree that you:
|
||||||
|
|
||||||
4. Allow the project the [Unlimited Rights](#Unlimited-Rights) to your contribution
|
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
|
## Unlimited Rights
|
||||||
Our project is licensed under GPLv3. By providing a contribution to the project, it
|
Our project is licensed under GPLv3. By providing a contribution to the project, it
|
||||||
|
@ -29,3 +30,9 @@ If you want to be named in as a contributor in the CONTRIBUTOR file, then includ
|
||||||
this notition in your pull request. Preferred format: Full Name, with optional the
|
this notition in your pull request. Preferred format: Full Name, with optional the
|
||||||
company name and/or your e-mail address).
|
company name and/or your e-mail address).
|
||||||
|
|
||||||
|
## Developer Guidelines
|
||||||
|
|
||||||
|
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.
|
Loading…
Reference in New Issue