Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
marcoistasy committed Aug 6, 2019
1 parent ddb65ac commit 1664129
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

Thanks for taking the time to contribute!

The following is a set of guidelines for contributing to Imagine OCR. These are just guidelines, not rules, so use your best judgement and feel free to propose changes to this document in a pull request.
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

Imagine-OCR is built on top of [Tensorflow](http://tensorflow.org) using the [Object Detection API](https://github.com/tensorflow/models). If you are new to these frameworks, please head over to the respective links to learn more.
imagineOCR is built on top of [Tensorflow](http://tensorflow.org) using the [Object Detection API](https://github.com/tensorflow/models). 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 [Github Wiki](https://github.com/marcoistasy/imagine-ocr/wiki) to contribute and learn how to use the project.
* We are currently working on documentation. Please head over to our [Wiki](https://www.notion.so/Wiki-3c27906875224f3c9509deec23a98bb0) to contribute and learn how to use the project.

* If you have any questions regarding imagine-ocr, open an [issue](https://github.com/marcoistasy/imagine-ocr/issues/new/choose).
* If you have any questions regarding imagineOCR, open an [issue](https://github.com/marcoistasy/imagineOCR/issues/new/choose).

## Issue
Ensure the bug was not already reported by searching on GitHub under [issues](https://github.com/marcoistasy/imagine-ocr/issues). If you're unable to find an open issue addressing the bug, open a [new issue](https://github.com/marcoistasy/imagine-ocr/issues/new/choose).
Ensure the bug was not already reported by searching on GitHub under [issues](https://github.com/marcoistasy/imagine-ocr/issues) or our official [roadmap](https://www.notion.so/39742f2396ae47d9ac848f2df7112ca3?v=48efbd1371a44f42801d0ab4b3075bc3). If you're unable to find an open issue addressing the bug, open a [new issue](https://github.com/marcoistasy/imagineOCR/issues/new/choose).

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

Expand All @@ -25,7 +25,6 @@ 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).
* Screenshots for GUI issues.
* Version of imagine-ocr and relevant decencies.
* The operating system.

Expand Down

0 comments on commit 1664129

Please sign in to comment.