docs/community/community_contribution.en.md
Thank you for your long-term support and attention to PaddleOCR. Building a professional, harmonious, and mutually helpful open-source community with developers is the goal of PaddleOCR. This document showcases existing community contributions, explains various types of contributions, and describes new opportunities and processes, hoping to make the contribution process more efficient and the path clearer.
PaddleOCR hopes to help every developer with a dream realize their ideas through the power of AI and enjoy the pleasure of creating value.
<a href="https://github.com/PaddlePaddle/PaddleOCR/graphs/contributors"> </a>PaddleOCR warmly welcomes community contributions of various services, deployment examples, and software applications built around PaddleOCR. Certified community contributions will be added to the community contribution table above, providing increased visibility for developers and bringing honor to PaddleOCR:
Project format: Officially certified community project code should follow good standards and structure, and should also include a detailed README.md explaining how to use the project. Adding paddleocr to your requirements.txt file will automatically include your project in PaddleOCR's "used by" list.
Merge process: If it is an update or upgrade to an existing PaddleOCR tool, it will be merged into the main repo. If it extends new functionality for PaddleOCR, please contact the official team first to confirm whether the project should be merged into the main repo. Even if the new functionality is not merged into the main repo, we will still increase visibility for your personal project as a community contribution.
If you encounter code bugs or unexpected behavior while using PaddleOCR, you can contribute your fixes:
For Python code standards, please refer to Appendix 1: Python Code Specification.
Please double-check before submitting code that no new bugs are introduced, and describe the optimization points in the PR. If the PR resolves a specific issue, please link to that issue in the PR. All PRs should follow the conventions in 3.2.10 Some Conventions For Submitting Code.
Please refer to Appendix 3: Pull Request Description before submitting. If you are not familiar with the git submission process, you can also refer to section 3.2 of Appendix 3.
If you encounter unclear descriptions, missing content, or broken links while using PaddleOCR, you can contribute your fixes. For documentation writing standards, please refer to Appendix 2: Document Specification.
We strongly encourage developers to use PaddleOCR to implement their own ideas. We also list some valuable extension directions that have been analyzed and are collected in the community project regular competition.
We warmly welcome developers to contact us before contributing code, documentation, corpora, or other content to PaddleOCR. This can greatly reduce communication costs during the PR process. Additionally, if you find certain ideas difficult to implement individually, we can recruit like-minded developers through SIG (Special Interest Group) to collaborate on the project. Projects contributed through the SIG channel will receive in-depth R&D support and operational resources (such as public account promotion, live courses, etc.).
Our recommended contribution process is:
[third-party] tag to the GitHub issue title, describe the problem encountered (and your proposed solution) or the functionality you want to extend, and wait for a response from the duty personnel. For example: [third-party] Contributing an iOS example for PaddleOCR.