This commit is contained in:
alex-krasn 2020-07-07 15:56:38 -07:00 коммит произвёл GitHub
Родитель a334cfc45f
Коммит 2abb0cb062
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
7 изменённых файлов: 121 добавлений и 121 удалений

Просмотреть файл

@ -1,112 +1,112 @@
# Contributing to OCR Form Labeling Tool # Contributing to Form OCR Testing Tool
We welcome [issues](https://github.com/Microsoft/OCR-Form-Tools/issues) and [pull requests](https://github.com/Microsoft/OCR-Form-Tools/pulls) into the project. We ask that you follow these simple guidelines: We welcome [issues](https://github.com/Microsoft/OCR-Form-Tools/issues) and [pull requests](https://github.com/Microsoft/OCR-Form-Tools/pulls) into the project. We ask that you follow these simple guidelines:
<!-- generated using: https://www.npmjs.com/package/markdown-toc--> <!-- generated using: https://www.npmjs.com/package/markdown-toc-->
<!-- command: `markdown-toc -i CONTRIBUTING.md --bullets "*"`--> <!-- command: `markdown-toc -i CONTRIBUTING.md --bullets "*"`-->
<!-- toc --> <!-- toc -->
* [Issues](#issues) * [Issues](#issues)
* [Pull Requests](#pull-requests) * [Pull Requests](#pull-requests)
* [Commit Message Guidelines](#commit-message-guidelines) * [Commit Message Guidelines](#commit-message-guidelines)
* [Commit Message Format](#commit-message-format) * [Commit Message Format](#commit-message-format)
* [Header](#header) * [Header](#header)
* [Type](#type) * [Type](#type)
* [Short Description](#short-description) * [Short Description](#short-description)
* [Body](#body) * [Body](#body)
* [Footer](#footer) * [Footer](#footer)
* [Commit Message Example](#commit-message-example) * [Commit Message Example](#commit-message-example)
* [Style](#style) * [Style](#style)
<!-- tocstop --> <!-- tocstop -->
## Issues ## Issues
* Look for duplicate issues & comment on thread if experiencing something similar * Look for duplicate issues & comment on thread if experiencing something similar
* Fill in template information (platform, OS, version, screenshots, etc.) * Fill in template information (platform, OS, version, screenshots, etc.)
## Pull Requests ## Pull Requests
1. Find an issue to work on, or create a new one. 1. Find an issue to work on, or create a new one.
1. Fork the repo and/or pull down the latest changes from `master`. 1. Fork the repo and/or pull down the latest changes from `master`.
1. Create branch following naming convention: `git checkout -b issue-<###>-<short-description>`. 1. Create branch following naming convention: `git checkout -b issue-<###>-<short-description>`.
1. Write code. 1. Write code.
1. Add unit tests. 1. Add unit tests.
1. Verify linting and unit tests by running `npm test`. 1. Verify linting and unit tests by running `npm test`.
1. Update docs if needed. 1. Update docs if needed.
1. Rebase on `master` and resolve conflicts. 1. Rebase on `master` and resolve conflicts.
1. Commit your changes using a descriptive commit message that follows [our commit message conventions](#commit-message-guidelines). Adherence to these conventions is necessary for the [change log](CHANGELOG.md) to be automatically generated from these messages. 1. Commit your changes using a descriptive commit message that follows [our commit message conventions](#commit-message-guidelines). Adherence to these conventions is necessary for the [change log](CHANGELOG.md) to be automatically generated from these messages.
1. Submit PR to `master` branch. 1. Submit PR to `master` branch.
Please try to keep PRs small to decrease the time required to review and merge. Please try to keep PRs small to decrease the time required to review and merge.
## Commit Message Guidelines ## Commit Message Guidelines
We have adopted standards similar to [Angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit) for how our git commit messages should be formatted. This leads to more readable messages, which are easier to follow when looking through the project history. Those messages are used to generate the [change log](CHANGELOG.md). We have adopted standards similar to [Angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit) for how our git commit messages should be formatted. This leads to more readable messages, which are easier to follow when looking through the project history. Those messages are used to generate the [change log](CHANGELOG.md).
### Commit Message Format ### Commit Message Format
Each commit message consists of a **header**, a **body** and a **footer**. Each commit message consists of a **header**, a **body** and a **footer**.
```text ```text
<type>: <short description> <type>: <short description>
<BLANK LINE> <BLANK LINE>
<body> <body>
<BLANK LINE> <BLANK LINE>
<footer> <footer>
``` ```
### Header ### Header
#### Type #### Type
Must be one of the following: Must be one of the following:
* **build**: Changes that affect the build system or external dependencies * **build**: Changes that affect the build system or external dependencies
* **ci**: Changes to our CI configuration files and scripts * **ci**: Changes to our CI configuration files and scripts
* **docs**: Documentation only changes * **docs**: Documentation only changes
* **feat**: A new feature * **feat**: A new feature
* **fix**: A bug fix * **fix**: A bug fix
* **perf**: A code change that improves performance * **perf**: A code change that improves performance
* **refactor**: A code change that neither fixes a bug nor adds a feature * **refactor**: A code change that neither fixes a bug nor adds a feature
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) * **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
* **test**: Adding missing tests or correcting existing tests * **test**: Adding missing tests or correcting existing tests
* **accessibility**: Adding support for accessibility * **accessibility**: Adding support for accessibility
#### Short Description #### Short Description
Contains a succinct description of the change: Contains a succinct description of the change:
* use the imperative, present tense: "change" not "changed" nor "changes" * use the imperative, present tense: "change" not "changed" nor "changes"
* don't capitalize the first letter * don't capitalize the first letter
* no dot (.) at the end * no dot (.) at the end
### Body ### Body
Just as in the **short description**, use the imperative, present tense: "change" not "changed" nor "changes". Just as in the **short description**, use the imperative, present tense: "change" not "changed" nor "changes".
The body should include the motivation for the change and contrast this with previous behavior. The body should include the motivation for the change and contrast this with previous behavior.
### Footer ### Footer
The footer should contain any information about **breaking changes** and is also the place to The footer should contain any information about **breaking changes** and is also the place to
reference Azure DevOps user stories/tasks or GitHub issues that this commit **closes**. reference Azure DevOps user stories/tasks or GitHub issues that this commit **closes**.
### Commit Message Example ### Commit Message Example
```text ```text
fix: add debouncing to asset scroller to correct browser scroll position fix: add debouncing to asset scroller to correct browser scroll position
There is no debouncing when we store the asset container's scroll position. There is no debouncing when we store the asset container's scroll position.
This results in erratic, jumpy scrolling and a poor user experience. Improve This results in erratic, jumpy scrolling and a poor user experience. Improve
stability and usability with debouncing. stability and usability with debouncing.
AB#17056 AB#17056
``` ```
## Style ## Style
* This repo uses [EditorConfig](https://editorconfig.org/) to maintain consistent styles across multiple platforms and IDEs. Please refer to * This repo uses [EditorConfig](https://editorconfig.org/) to maintain consistent styles across multiple platforms and IDEs. Please refer to
this [guide](docs/STYLE.md) for more information. this [guide](docs/STYLE.md) for more information.
Thank you! Thank you!

Просмотреть файл

@ -1,4 +1,4 @@
# OCR Form Labeling Tool # Form OCR Testing Tool
## Features Preview ## Features Preview
@ -87,7 +87,7 @@ Enable CORS on your storage account. Select your storage account in the Azure po
### Create Connections ### Create Connections
OCR Form Labeling Tool is a 'Bring Your Own data' (BYOD) application. In this tool, connections are used to configure and manage source (the assets to label) and target (the location where labels should be exported). The source and target are the same location in OCR Form Labeling Tool. Eventually, they together will be inputs to [Form Recognizer](https://docs.microsoft.com/en-us/azure/cognitive-services/form-recognizer/). Form OCR Testing Tool is a 'Bring Your Own data' (BYOD) application. In this tool, connections are used to configure and manage source (the assets to label) and target (the location where labels should be exported). The source and target are the same location in Form OCR Testing Tool. Eventually, they together will be inputs to [Form Recognizer](https://docs.microsoft.com/en-us/azure/cognitive-services/form-recognizer/).
Connections can be set up and shared across projects. They use an extensible provider model, so new source/target providers can easily be added. Connections can be set up and shared across projects. They use an extensible provider model, so new source/target providers can easily be added.
Currently, both this labeling tool and [Form Recognizer](https://docs.microsoft.com/en-us/azure/cognitive-services/form-recognizer/) only support [Azure blob storage](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction). Currently, both this labeling tool and [Form Recognizer](https://docs.microsoft.com/en-us/azure/cognitive-services/form-recognizer/) only support [Azure blob storage](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction).
@ -209,7 +209,7 @@ This project is cloned and modified from [VoTT](https://github.com/microsoft/VoT
## Contributing ## Contributing
There are many ways to contribute to OCR Form Labeling Tool -- please review our [contribution guidelines](CONTRIBUTING.md). There are many ways to contribute to Form OCR Testing Tool -- please review our [contribution guidelines](CONTRIBUTING.md).
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see
the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com)

Просмотреть файл

@ -5,7 +5,7 @@
"name": "Microsoft", "name": "Microsoft",
"url": "https://github.com/microsoft/OCR-Form-Tools" "url": "https://github.com/microsoft/OCR-Form-Tools"
}, },
"description": "OCR Form Labeling Tool - an labeling tool for forms.", "description": "Form OCR Testing Tool - an labeling tool for forms.",
"homepage": ".", "homepage": ".",
"repository": { "repository": {
"type": "git", "type": "git",

Просмотреть файл

@ -24,12 +24,12 @@
work correctly both with client-side routing and a non-root public URL. work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`. Learn how to configure a non-root public URL by running `npm run build`.
--> -->
<title>OCR Form Labeling Tool</title> <title>Form OCR Testing Tool</title>
</head> </head>
<body> <body>
<noscript>You need to enable JavaScript to run this app.</noscript> <noscript>You need to enable JavaScript to run this app.</noscript>
<div id="rootdiv"></div> <div id="rootdiv"></div>
<div style="display: none;">OCR Form Labeling Tool</div> <div style="display: none;">Form OCR Testing Tool</div>
<!-- <!--
This HTML file is a template. This HTML file is a template.
If you open it directly in the browser, you will see an empty page. If you open it directly in the browser, you will see an empty page.

Просмотреть файл

@ -1,6 +1,6 @@
{ {
"short_name": "Form Tool", "short_name": "Form Tool",
"name": "OCR Form Labeling Tool", "name": "Form OCR Testing Tool",
"icons": [ "icons": [
{ {
"src": "favicon.ico", "src": "favicon.ico",

Просмотреть файл

@ -9,7 +9,7 @@ import { IAppStrings } from "../strings";
* App Strings for English language * App Strings for English language
*/ */
export const english: IAppStrings = { export const english: IAppStrings = {
appName: "OCR Form Labeling Tool", appName: "Form OCR Testing Tool",
common: { common: {
displayName: "Display name", displayName: "Display name",
description: "Description", description: "Description",

Просмотреть файл

@ -9,7 +9,7 @@ import { IAppStrings } from "../strings";
* App Strings for Spanish language * App Strings for Spanish language
*/ */
export const spanish: IAppStrings = { export const spanish: IAppStrings = {
appName: "Herramienta de etiquetado de formularios OCR", appName: "Herramienta de prueba de formulario OCR",
projectService: { projectService: {
existingLabelFiles: "", existingLabelFiles: "",
}, },