Contributions are welcome, and they are greatly appreciated! Every little
helps, and credit will always be given.
It's required to sign CLA before your first code submission to MindOCR community.
For individual contributor, please refer to ICLA online document for the detailed information.
Report bugs at https://github.com/mindspore-lab/mindocr/issues.
If you are reporting a bug, please include:
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to fix it.
MindOCR could always use more documentation, whether as part of the
official MindOCR docs, in docstrings, or even on the web in blog posts,
articles, and such.
The best way to send feedback is to file an issue at https://github.com/mindspore-lab/mindocr/issues.
If you are proposing a feature:
Ready to contribute? Here's how to set up mindocr
for local development.
Fork the mindocr
repo on GitHub.
Clone your fork locally:
git clone git@github.com:your_name_here/mindocr.git
After that, you should add official repository as the upstream repository:
git remote add upstream git@github.com:mindspore-lab/mindocr
Install your local copy into a conda environment. Assuming you have conda installed, this is how you set up your fork for local development:
conda create -n mindocr python=3.8
conda activate mindocr
cd mindocr
pip install -e .
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you finish making changes, check that your changes pass the linters and the tests:
pre-commit run --show-diff-on-failure --color=always --all-files
pytest
If all static linting are passed, you will get output like:
otherwise, you need to fix the warnings according to the output:
To get pre-commit and pytest, just pip install them into your conda environment.
Commit your changes and push your branch to GitHub:
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Before you submit a pull request, check that it meets these guidelines:
You can install the git hook scripts instead of linting with pre-commit run -a
manually.
run flowing command to set up the git hook scripts
pre-commit install
now pre-commit
will run automatically on git commit
!
A reminder for the maintainers on how to deploy.
Make sure all your changes are committed.
Then run:
bump2version patch # possible: major / minor / patch
git push
git push --tags
GitHub Action will then deploy to PyPI if tests pass.
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》