Skip to content

Latest commit

 

History

History
executable file
·
41 lines (27 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
41 lines (27 loc) · 2.11 KB
Raw

Contributing Guidelines

Thanks for taking the time to contribute!

The following is a set of guidelines for contributing to imagineOCR. These are just guidelines, not rules, so use your best judgement and feel free to propose changes to this document in a pull request.

Getting Started

imagineOCR is built on top of Tensorflow using the Object Detection API. If you are new to these frameworks, please head over to the respective links to learn more.

Community

  • We are currently working on documentation. Please head over to our Wiki to contribute and learn how to use the project.

  • If you have any questions regarding imagineOCR, open an issue.

Issue

Ensure the bug was not already reported by searching on GitHub under issues or our official roadmap. If you're unable to find an open issue addressing the bug, open a new issue.

Please pay attention to the following points while opening an issue.

Write detailed information

Detailed information is very helpful to understand an issue.

For example:

  • How to reproduce the issue, step-by-step.
  • The expected behavior (or what is wrong).
  • Version of imagine-ocr and relevant decencies.
  • The operating system.

Pull Requests

Pull Requests are always welcome.

  1. When you edit the code, please run npm run test to check the formatting of your code before you git commit.
  2. Ensure the PR description clearly describes the problem and solution. It should include:
    • The operating system on which you tested.
    • The relevant dependencies and versions.
    • The relevant issue number, if applicable.
  3. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.