Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.58 KB
Raw

Contributing Guidelines

Thank you for considering contributing to the Python OCR Project with Pix2Text and GUI using PyQt5!

We welcome contributions that enhance the project's functionality, improve its usability, or provide additional features. To ensure a smooth collaboration process, please follow the guidelines below.

Supported the following repository for windows & macOS running this repository properly with suppling the requirements which needed.

How to Contribute

  1. Fork the Repository: Click the "Fork" button on the top right corner of this repository. This will create a copy of the repository in your GitHub account.

  2. Create a New Branch: Create a new branch for your contributions. This helps keep your changes isolated from the main branch.

git checkout -b feature/your-feature

  1. Make Changes: Implement your changes, enhancements, or fixes.

  2. Test Your Changes: Ensure your changes work correctly and do not break existing functionality.

  3. Commit Your Changes: Commit your changes with a clear and concise commit message.

git commit -m "Add your commit message here"

  1. Push Changes and Create Pull Request: Push your changes to your forked repository and create a Pull Request (PR) to the original repository's main branch.

  2. Discuss and Review: Your PR will be reviewed by project maintainers. They might ask for changes or suggestions. Be responsive to the feedback.

  3. Merge and Celebrate: Once your changes are approved, they will be merged into the main repository. Congratulations, you've contributed to the project!