Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

33 lines (20 loc) · 2.49 KB

Welcome to Kurtosis contributing guide

Thank you for investing your time in contributing to our project! In this guide you will get an overview of the contribution workflow.

Bugs

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.

Feature Requests

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.

Documentation

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.

Questions, help, or feedback

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:

Pull Request

To submit code for review, follow these steps:

  1. Make sure your changes are building and passing all tests locally, project following README's guidance
  2. Make sure your code is in accordance with our Style Guide
  3. Open a PR whose title obeys the conventional commits convention and fill out the information provided in the Pull Request template.
  4. After all CI checks pass, tag @kurtosis-tech/engineers for review