Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

44 lines (26 loc) · 2.4 KB
Raw

Contributing

Thanks for your interest in contributing! This is an open source project, so we appreciate community contributions.

Pull requests for bug fixes are welcome, but before submitting new features or changes to current functionalities open an issue and discuss your ideas or propose the changes you wish to make. After a resolution is reached a PR can be submitted for review. PRs created before a decision has been reached may be closed.

For commit messages, try to use the same conventions as most Go projects, for example:

pkg/kubehound/graph: add new projected volume type support

Added a new volume type support (Amazon EBS) to the model

Please apply the same logic for Pull Requests and Issues: start with the package name, followed by a colon and a description of the change, just like the official Go language.

All new code is expected to be covered by tests.

PR Checks

We expect all PR checks to pass before we merge a PR

Please feel free to comment on a PR if there is any difficulty or confusion about any of the checks.

What to expect

We try to review new PRs within two weeks of them being opened. If more than three weeks have passed with no reply, please feel free to comment on the PR to bubble it up.

If a PR sits open for more than a month awaiting work or replies by the author, the PR may be closed due to staleness. If you would like to work on it again in the future, feel free to open a new PR and someone will review.

Adding an Attack

To add a new attack to KubeHound, please do the following:

  • Document the attack in the edges documentation directory

  • Define the attack constraints in the graph database schema builder

  • Create an implementation of the edge.Builder interface that determines whether attacks are possible by quering the store database and writes any found as edges into the graph database

  • Create the resources file in the test cluster that will introduce an instance of the attack into the test cluster

  • Add an edge system test that verifies the attack is correctly created by KubeHound

    See here for a previous example PR.