Welcome to Kusion! Kusion is the cloud-native platform engineering engine of KusionStack.
We warmly appreciate your talent and creativity in contributing to this project. This guide will help direct you to the best places to start contributing. Follow the instructions below, you'll be able to pick up issues, write code to fix them, and get your work reviewed and merged.
Feel free to create issues and contribute your code. Whether you are an experienced developer or just beginning your journey in the open-source world, we highly encourage your participation.
If you have any questions or need further information, please don't hesitate to contact us.
The first step to start contributing to Kusion is to find something to work on. Help is always welcome, and no contribution is too small!
Here are some things you can do today to get started contributing:
We use issues to track tasks. Choose an existing issue with the label good first issue
or help wanted
is a good choice, or you can open a new issue. Now, Kusion provides three issue templates as follows, please choose one according to your need:
In the issue, please describe your problem clearly and accurately, and choose a label to define the issue's type. There are the commonly used labels:
After opening an issue, you could contribute codes to Kusion by a pull request. Here are the steps you should follow:
Kusion adopts trunk-based development, i.e., the code used for release is maintained on the main branch. And to keep the repository tidy, Kusion only has the main branch.
Thus, to develop Kusion, you have to fork the KusionStack/kusion repository to your workspace, and then check out a new branch to develop coding.
Now you can start coding to solve the issue. To maintain the code quality of Kusion, unit tests are indispensable for the functions you added or updated.
After the development is completed, commit and push to your own forked repository. Cause the code will merge into Kusion repository by pull request, [commitlint/config-conventional should be followed, the legal prefixes for the commit message are shown below:
Open a pull request from the develop branch of your forked repository to the main branch of Kusion. You should clearly describe what you do in the PR, and link it to an issue. Besides, the PR title should also follow the commit conventions described above, and must be 5-256 characters in length, prefix WIP
and [WIP]
are not allowed.
If it was your first pull request, you need to sign our CLA(Contributor License Agreement). The only thing you need to do is to post a pull request comment same as the below format:
I have read the CLA Document and I hereby sign the CLA
If your CLA signature failed, you may find the solutions below:
To keep the reliability of the Kusion project, the following check will get triggered automatically:
Please make sure your PR passes these checks.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。