Skip to content

Contribution

Takuma Otake edited this page Feb 4, 2023 · 3 revisions

Introduction

Thank you for your interest in contributing to this project.
Below is an explanation of our contributions to the language and transcription service, but we also welcome any other contributions.
However, I'm always busy, so I can't immediately reflect what you have contributed to the release.
Therefore, please wait for a few months for the contributions to be reflected.
*The rules for contributing to this project follow the contents of the Open Source Guides.

Contribution to translation

Currently, the languages ​​available for this application are:
English, Japanese(日本語)
You may help us improve the translation of the above languages, or you may add support for new languages.
Please note that this application does not support the ability to read external language data, so any changes to the language will need to be rebuilt.
Therefore, the new language data created will be incorporated in the next release.

Contribution method

Add the created language file to the Languages folder.
Then write information about the language to be added to the language information file.

  • If you need a template, use the en-US (English) language file.
  • This application works even if all the text is not included in the language file (missing text will be displayed in English).

Contribution to transcription service

Currently, the transcription services available in this application are:
Google Cloud Vision API
You may help us fix bugs or add features to the transcription service above, or you may add support for a new transcription service.
Please note that this application does not support the ability to load programs externally, so any changes to the transcription service will need to be rebuilt.
Therefore, the content that you have contributed will be incorporated in the next release.

Contribution method

Create a new folder (name should be service name) in the transcription service folder, and create a new class (name should be service name) that inherits the Service class in it. When you're done, write the transcription service information you want to add to the Functions class in the TranscriptionService namespace.

Prohibitions

For security reasons, it is forbidden for each transcription service's own programs to access programs in the Cloud_OCR_Snip namespace or to read or write application configuration files (including the additional data file).
Basic functionality is available in the Functions class of the TranscriptionService namespace, so please use that (if you need something that is not there, please open an issue).