Contribution Guidelines

How to contribute

We’re excited to have you consider contributing to our chaos! Contributions are always appreciated.

Krkn

Contributing to Krkn

If you would like to contribute to Krkn, but are not sure exactly what to work on, you can find a number of open issues that are awaiting contributions in issues.

Adding New Scenarios and Configurations

New Scenarios

We are always looking for new scenarios to make krkn better and more usable for our chaos community. If you have any ideas, please first open an issue to explain the new scenario you are wanting to add. We will review and respond with ideas of how to get started.

New Configuration to Scenarios

If you are currently using a scenario but want more configuration options, please open a github issue describing your use case and what fields and functionality you would like to see added. We will review the sugguestion and give pointers on how to add the functionality. If you feel inclined, you can start working on the feature and we’ll help if you get stuck along the way.

Work in Progress PR’s

If you are working on a contribution in any capacity and would like to get a new set of eyes on your work, go ahead and open a PR with ‘[WIP]’ at the start of the tite in your PR and tag the maintainers for review. We will review your changes and give you sugguestions to keep you moving!

Good PR Checklist

Here’s a quick checklist for a good PR, more details below:

One feature/change per PR
One commit per PR squash your commits
PR rebased on main (git rebase, not git pull)
Good descriptive commit message, with link to issue
No changes to code not directly related to your PR
Includes functional/integration test (more applicable to krkn-lib)
Includes link to documentation PR (documentation hosted in https://github.com/krkn-chaos/website)

Helpful Documents

Refer to the docs below to be able to test your own images with any changes and be able to contribute them to the repository