diff --git a/README.md b/README.md index 2fdb6af..3a9ce89 100644 --- a/README.md +++ b/README.md @@ -254,3 +254,36 @@ Next you'll have to build the kube-bench docker image using `make build-docker`, Finally we can use the `make kind-run` target to run the current version of kube-bench in the cluster and follow the logs of pods created. (Ctrl+C to exit) Everytime you want to test a change, you'll need to rebuild the docker image and push it to cluster before running it again. ( `make build-docker kind-push kind-run` ) + +# GitHub Issues + +## Bugs + +If you think you have found a bug please follow the instructions below. + +- Please spend a small amount of time giving due diligence to the issue tracker. Your issue might be a duplicate. +- Open a [new issue](https://github.com/aquasecurity/kube-bench/issues/new) if a duplicate doesn't already exist. +- Note the version of kube-bench you are running (from `kube-bench version`) and the command line options you are using. +- Note the version of kubernetes you are running (from `kubectl version` or `oc version` for Openshift). +- Set `-v 10` command line option and save the log output. Please paste this into your issue. +- Remember users might be searching for your issue in the future, so please give it a meaningful title to help others. + +## Features + +We also use the GitHub issue tracker to track feature requests. If you have an idea to make kube-bench even more awesome follow the steps below. + +- Open a [new issue](https://github.com/aquasecurity/kube-bench/issues/new). +- Remember users might be searching for your issue in the future, so please give it a meaningful title to helps others. +- Clearly define the use case, using concrete examples. For example: I type `this` and kube-bench does `that`. +- If you would like to include a technical design for your feature please feel free to do so. + +## Pull Requests + +We welcome pull requests! + +- Your PR is more likely to be accepted if it focuses on just one change. +- Please include a comment with the results before and after your change. +- 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!). +- You're welcome to submit a **WIP** *(work in progress)* PR if you would like early feedback on an idea or an approach. +- Happy coding! +