Contributors Guide
+ +Welcome to the Kuadrant contributors guide! We are delighted that you are interested in getting involved in our project 🎉
+As you get started, you are in the best position to give us feedback on areas of our project that we need help with such as:
+-
+
- Gaps or inaccuracies in our getting started guide or documentation +
- Problems found while setting up your local development environment +
If anything doesn't make sense, or doesn't work when you run it, please feel free to either open a Github issue against the relevant component repository or reach out to us directly on Slack or via the Kuadrant mailing list.
+Ways to Contribute
+We welcome many different types of contributions covering areas such as:
+-
+
- New features +
- Bug fixes +
- Documentation updates +
- Release management +
- Discussions, feedback and/or guidance on Slack/Mailing List +
Community Calls
+Each week we host a Kuadrant Community call which provides an open forum to discuss all things Kuadrant. Anyone is welcome to come along to this meeting to propose a topic, join in on discussions or just listen in to gain some context into what's going on in the project. For further details on how to join the call, see the Events and Meetings section on the website community page.
+Missed a meeting? Don't worry! All of our Community calls are recorded and available from our YouTube channel.
+Ask for Help
+The best way to reach us with a question when contributing is to ask on:
+-
+
- Our Public Slack channel +
- The Kuadrant mailing list +
Reporting Issues
+To report an issue in the Kuadrant project, you can create a Github issue in the relevant component repository e.g. Limitador, Kuadrant Operator, Authorino etc. If you are unsure of which component to log against, reach out via Slack or email. The more information you can provide the easier it will be to help resolve the issue, so please don't be shy on details.
+Find an Issue
+A list of good first issues can be found from the Kuadrant Github projects board. These issues are categorised per component. If you see an issue you're interested in progressing mark yourself as an assignee and update the issue status to In Progress
On the rare occasion that there are no good first issues available, that’s OK! There is likely still something for you to work on. If you want to contribute but you don’t know where to start or can't find a suitable issue, you can reach out via the Public Slack channel for suggestions and/or guidance.
+ +