KubeVela project is initialized and maintained by the cloud native community since day 0 with bootstrapping contributors from 8+ different organizations. We intend for KubeVela to have an open governance since the very beginning and donate the project to neutral foundation as soon as it's released. To help us create a safe and positive community experience for all, we require all participants to adhere to the Code of Conduct.
This document is a guide to help you through the process of contributing to KubeVela.
You can contribute to KubeVela in several ways. Here are some examples:
- Contribute to the KubeVela codebase.
- Contribute to the KubeVela docs.
- Report and triage bugs.
- Develop community CRD operators as workload or trait and contribute to catalog.
- Write technical documentation and blog posts, for users and contributors.
- Organize meetups and user groups in your local area.
- Help others by answering questions about KubeVela.
For more ways to contribute, check out the Open Source Guides.
Before submitting a new issue, try to make sure someone hasn't already reported the problem. Look through the existing issues for similar issues.
Report a bug by submitting a bug report. Make sure that you provide as much information as possible on how to reproduce the bug.
Follow the issue template and add additional information that will help us replicate the problem.
If you believe you've found a security vulnerability, please read our security policy for more details.
If you have an idea to improve KubeVela, submit an feature request.
If you don't have the knowledge or time to code, consider helping with issue triage. The community will thank you for saving them time by spending some of yours.
Read more about the ways you can Triage issues.
If you have a question and you can't find the answer in the documentation, the next step is to ask it on the github discussion.
It's important to us to help these users, and we'd love your help. You can help other KubeVela users by answering their questions.
Unsure where to begin contributing to KubeVela? Start by browsing issues labeled good first issue or help wanted.
- Good first issue issues are generally straightforward to complete.
- Help wanted issues are problems we would like the community to help us with regardless of complexity.
If you're looking to make a code change, see how to set up your environment for local development.
When you're ready to contribute, it's time to Create a pull request.