Skip to content

Latest commit

 

History

History
43 lines (24 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

43 lines (24 loc) · 1.76 KB

Contribution to Kusk Gateway

Thanks for reaching out 🎉

If you're new in Open-source community there is nice guide how to start contributing to projects: https://github.com/firstcontributions/first-contributions

Code of Conduct

This project and everyone participating in it is governed by the CNCF code of conduct.

Have questions or idea?

We're using github discussions for managing pre-development ideas and clarifications, feel free to add one at our Q&A discussion page

New ideas should be placed in Ideas discussion page

General guidance for contributing to Kusk Gateway project

You're very welcome to help in Kusk Gateway development, there is a lot of incoming work to do :).

We're trying hard to limit technical debt from the beginning so we defined simple rules into Kusk Gateway repo to help with it.

For golang based components

  • Always use gofmt (there is only one true way of doing code formatting ;) ).
  • Follow golang good practices (proverbs) in your code.
  • Tests are your friend (we will target 80% CC in our code).
  • Use clean names, don't break basic design patterns and rules.

For infrastructure / Kubernetes based components

  • We're using helm charts to build and share Kusk Gateway
  • Comment non-obvious decisions
  • Use current Helm/Kubernetes versions

How can I help?