It's required to sign CLA before your first code submission to MindSpore community.
For individual contributor, please refer to ICLA online document for the detailed information.
Please follow this style to make MindSpore 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 MindSpore community.
Unittest guidelines
The Python unittest style suggested by pytest and C++ unittest style suggested by Googletest Primer are used in MindSpore community.
Fork MindSpore Hub repository
Before submitting code to MindSpore project, please make sure that this project have been forked to your own repository. It means that there will be parallel development between MindSpore Hub 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 Gitee
git clone https://gitee.com/{insert_your_forked_repo}/hub.git
git remote add upstream https://gitee.com/mindspore/hub.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
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 MindSpore repository
In the last step, your need to pull a compare request between your new branch and MindSpore master
branch. After finishing the pull request, the Jenkins CI will be automatically set up for building test.
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:
You should refer to mshub_res/README before
you upload your own model into mindspore model hub.
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》