Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

65 lines (42 loc) · 2.43 KB
Raw

Contributing to OCR-Handwritten-text-recognition Project

Thank you for considering contributing to our project! Contributions are welcome from everyone. This guide outlines how you can contribute to this repository.

How to Contribute

  1. Fork the Repository: Start by forking the repository to your own GitHub account.

  2. Clone the Repository: Clone the forked repository to your local machine using Git.

    git clone https://github.com/rishibharadwajsai/OCR-Handwritten-text-recognition.git
cd OCR-Handwritten-text-recognition

  3. Create a Branch: Create a new branch for your contribution.

    git checkout -b feature/my-contribution

    Replace feature/my-contribution with a descriptive name for your branch.

  4. Make Changes: Make your changes or additions to the codebase.

  5. Commit Changes: Commit your changes with a descriptive commit message.

    git add .
git commit -m "Add feature: Description of your changes"

  6. Push Changes: Push your changes to your forked repository.

    git push origin feature/my-contribution

  7. Submit a Pull Request (PR):

    • Go to your forked repository on GitHub.
    • Click on the "Compare & pull request" button next to your branch.
    • Fill out the PR template with details about your contribution.
    • Submit the pull request.

  8. Review and Discuss: Participate in the discussion and feedback process related to your pull request. Make any necessary updates based on feedback.

  9. Merge Pull Request: Once your pull request is approved and passes any required tests, it will be merged into the main repository.

Contribution Guidelines

  • Code Style: Follow the existing code style and conventions used in the repository.
  • Documentation: Ensure any new code or significant changes are well-documented.
  • Testing: If applicable, include tests for your changes and ensure they pass.
  • Be Respectful: Respect the opinions and efforts of others.

Additional Notes

  • Contributors must adhere to the Code of Conduct.
  • For major changes or feature additions, consider discussing them in an issue first to gather feedback.

Getting Help

If you have any questions or need assistance, feel free to reach out via rishi.lella123@gmail.com or open an issue.

Thank you for contributing to the OCR-Handwritten-text-recognition project!