Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.57 KB

How to contribute to Klutch

Contribute bug reports, issues, feature requests

  • Ensure the bug/issue/feature request has not already been reported by searching open and closed GitHub issues.
  • If you're unable to find an issue addressing the problem, open a new one. Be sure to include a title and a clear description, and as much relevant information as possible. If possible, please provide a minimal reproducible example of the bug.

Contributing code

General guidelines

  • code submissions should include automated tests for the portions of the code that are modified
  • Golang changes must pass the automated linting step

Did you write a patch that fixes a bug?

  • Open a PR that includes the issue number of the GitHub issue discussing the bug
  • If no issue exists, create one (see above "Reporting a bug" section)

Do you want to add a feature to Klutch?

  • Reach out to the maintainers first using an issue to discuss if the feature is fit for inclusion into Klutch
  • If your suggestion gains sufficient traction and approval from the maintainers, go ahead and implement the change
  • After completing implementation, open a PR and respond to feedback

Others

Do you have any other concerns?

Reach out to the community or the maintainers through one of the channels here!


This guide was inspired by the Ruby on Rails contribution guidelines