diff options
author | mboelen <michael@cisofy.com> | 2015-09-06 18:54:18 +0300 |
---|---|---|
committer | mboelen <michael@cisofy.com> | 2015-09-06 18:54:18 +0300 |
commit | 98de52e0f88e71f09b78c93859c37fc38c1ca795 (patch) | |
tree | 08ed94ff69c3f6badabb1cd79a7e6b60e311ff77 /CONTRIBUTIONS.md | |
parent | 4a354c84796c5eae74053435ccc5ecd718734c34 (diff) |
Added some guidelines for pull requests
Diffstat (limited to 'CONTRIBUTIONS.md')
-rw-r--r-- | CONTRIBUTIONS.md | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/CONTRIBUTIONS.md b/CONTRIBUTIONS.md index 19a17295..34d1d970 100644 --- a/CONTRIBUTIONS.md +++ b/CONTRIBUTIONS.md @@ -1,8 +1,8 @@ # Contributions ## Pull Requests -Contributions to the Lynis project should be submitted as a pull request. The upstream -project can be found in our [GitHub repository](https://github.com/CISOfy/lynis). +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: @@ -17,6 +17,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) ## Unlimited Rights 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 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.
\ No newline at end of file |