CONTRIBUTING.md

Thank you for taking an interest in contributing to kube-bench !

Issues

• Feel free to open an issue for any reason as long as you make it clear if the issue is about a bug/feature/question/comment.
• Please spend some time giving due diligence to the issue tracker. Your issue might be a duplicate. If it is, please add your comment to the existing issue.
• Remember, users might be searching for your issue in the future. So please give it a meaningful title to help others.
• The issue should clearly explain the reason for opening the proposal if you have any, along with any relevant technical information.
• For questions and bug reports, please include the following information:
  • version of kube-bench you are running (from kube-bench version) along with the command line options you are using.
  • version of Kubernetes you are running (from kubectl version or oc version for Openshift).
  • Verbose log output, by setting the -v 10 command line option.

Pull Requests

1. Every Pull Request should have an associated Issue, unless you are fixing a trivial documentation issue.
2. Your PR is more likely to be accepted if it focuses on just one change.
3. Describe what the PR does. There's no convention enforced, but please try to be concise and descriptive. Treat the PR description as a commit message. Titles that start with "fix"/"add"/"improve"/"remove" are good examples.
4. Please add the associated Issue in the PR description.
5. There's no need to add or tag reviewers.
6. If a reviewer commented on your code or asked for changes, please remember to mark the discussion as resolved after you address it. PRs with unresolved issues should not be merged (even if the comment is unclear or requires no action from your side).
7. Please include a comment with the results before and after your change.
8. Your PR is more likely to be accepted if it includes tests (We have not historically been very strict about tests, but we would like to improve this!).