The BlueKing team upholds an open attitude and welcomes like-minded developers to contribute to the project. Before you start, please read the following instructions carefully.
MIT LICENSE is the open source license of BK-CI. Code contributed by anyone is protected by this license. Please make sure that you can accept the license before contributing your code.
Any functionality and feature should have its corresponding design document. Design documents need to be archived in the docs/features directory for the team to review and for subsequent developers to learn about the details of the features.
If you want to contribute functionalities and features to BK-CI project, please refer to the following steps:
Note: To ensure code quality, for big functionalities and features, the BlueKing tends to submit multiple PRs/MRs progressively, so that relevant developers can review the details of the changes. It may take more time to review a one-off and large-scale commit.
If you want to contribute your code, it is recommended to refer to existing documentation about features and development environment setup.
Since different projects of different teams have different code commit comments, in order to standardize the commit message of different teams in the open source environment, different marks are used to differentiate committed changes.
git commit -m 'mark: comment of the commit issue #123'
git commit -m 'fix: the bug that the worker-agent.jar process has delayed exit on some third-party agents #29'
|feature/feat||Develop a new feature|
|bug/fix/bugfix||Fix a bug|
|refactor/perf||Refactor the code/Optimize configurations & parameters/Optimize the logic and the functionality|
|test||Add unit testing cases|
|info||Add comment information|
|format||On the premise of not modifying business logic, only format the code|
|merge||Only merge and synchronize branches|
|depend||Add, delete or modify the dependencies of the project|
|chore||Relevant code like build scripts and tasks|
|del||Destructive actions like deleting functionalities and APIs that are still in use|
If you are already dealing with an existing issue and have a reasonable solution, you are recommended to reply to the issue, so that the BlueKing team or other developers and users know that you are interested in the issue and have made positive progress, which prevents repetition and avoids waste of manpower. The BlueKing team upholds an open attitude and is willing to discussion solutions with you. We look forward to having you submit PR/MR.
Steps to Commit a Fix
For fixing issues, the BlueKing team hopes that one PR/MR can cover all the relevant content, including but not limited to the code, the documentation and the user guide.
Please refer to BK-CI Review Process for relevant review process.
The BlueKing team uses issues to track bugs, feature, etc.
When submitting a relevant bug, please search for existing or similar issues to ensure that there is no redundancy.
If you confirm that this is a new bug, please include the following information when submitting.
：Code submit frequency
：React/respond to issue & PR etc.
：Well-balanced team members and collaboration
：Recent popularity of project
：Star counts, download counts etc.