It's required to sign CLA before your first code submission to MindCV community.
For individual contributor, please refer to ICLA online document for the detailed information.
Please follow this style to make MindCV easy to review, maintain and develop.
Coding guidelines
The Python coding style suggested by Python PEP 8 Coding Style and C++ coding style suggested by Google C++ Coding Guidelines are used in MindCV community. The CppLint, CppCheck, CMakeLint, CodeSpell, Lizard, ShellCheck and PyLint are used to check the format of codes, installing these plugins in your IDE is recommended.
Unittest guidelines
The Python unittest style suggested by pytest and C++ unittest style suggested by Googletest Primer are used in MindCV community. The design intent of a testcase should be reflected by its name of comment.
Refactoring guidelines
We encourage developers to refactor our code to eliminate the code smell. All codes should conform to needs to the coding style and testing style, and refactoring codes are no exception. Lizard threshold for nloc (lines of code without comments) is 100 and for cnc (cyclomatic complexity number) is 20, when you receive a Lizard warning, you have to refactor the code you want to merge.
Document guidelines
We use MarkdownLint to check the format of markdown documents. MindCV CI modifies the following rules based on the default configuration.
For details, please refer to RULES.
Fork MindCV repository
Before submitting code to MindCV project, please make sure that this project have been forked to your own repository. It means that there will be parallel development between MindCV repository and your own repository, so be careful to avoid the inconsistency between them.
Clone the remote repository
If you want to download the code to the local machine, git
is the best way:
# For GitHub
git clone https://github.com/{insert_your_forked_repo}/mindcv.git
git remote add upstream https://github.com/mindlab-ai/mindcv.git
Develop code locally
To avoid inconsistency between multiple branches, checking out to a new branch is SUGGESTED
:
git checkout -b {new_branch_name} origin/master
Taking the master branch as an example, MindCV may create version branches and downstream development branches as needed, please fix bugs upstream first.
Then you can change the code arbitrarily.
Push the code to the remote repository
After updating the code, you should push the update in the formal way:
git add .
git status # Check the update status
git commit -m "Your commit title"
git commit -s --amend #Add the concrete description of your commit
git push origin {new_branch_name}
Pull a request to MindCV repository
In the last step, your need to pull a compare request between your new branch and MindCV master
branch. After finishing the pull request, the Jenkins CI will be automatically set up for building test. Your pull request should be merged into the upstream master branch as soon as possible to reduce the risk of merging.
A great way to contribute to the project is to send a detailed report when you encounter an issue. We always appreciate a well-written, thorough bug report, and will thank you for it!
When reporting issues, refer to this format:
Issues advisory:
PRs advisory:
Dear OpenI User
Thank you for your continuous support to the Openl Qizhi Community AI Collaboration Platform. In order to protect your usage rights and ensure network security, we updated the Openl Qizhi Community AI Collaboration Platform Usage Agreement in January 2024. The updated agreement specifies that users are prohibited from using intranet penetration tools. After you click "Agree and continue", you can continue to use our services. Thank you for your cooperation and understanding.
For more agreement content, please refer to the《Openl Qizhi Community AI Collaboration Platform Usage Agreement》