Thank you for investing your time in contributing to our project! In this guide you will get an overview of the contribution workflow.
If you spot a bug, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using the bug report template.
If you have a feature request, search if a similar feature request already exists. If a related feature request doesn't exist, you can open a feature request.
If you notice an issue in our docs (e.g. typo, grammar, conflicting information), first search to see if there is already an issue open for it. Otherwise, please file a docs issue report and we will address it as soon as we can.
If you have a question around how Kurtosis works and the docs aren't enough, we're more than happy to help and chat about your use case via the following ways:
- Get help in our Discord server
- Email us at [email protected]
- Schedule a 1:1 session with us here
To submit code for review, follow these steps:
- Make sure your changes are building and passing all tests locally, project following README's guidance
- Make sure your code is in accordance with our Style Guide
- Open a PR whose title obeys the conventional commits convention and fill out the information provided in the Pull Request template.
- After all CI checks pass, tag
@kurtosis-tech/engineers
for review