Commit 0ee2aa3d authored by Balázs Szilágyi's avatar Balázs Szilágyi

Add contributing.md

See: #1
parent 1c2cb86f
Pipeline #139929304 passed with stages
in 12 minutes and 17 seconds
# How to contribute
Contributions are welcome in any form :) The project currently maintained in [GitLab](https://gitlab.com/zyxneo/typing). If you do not like to use its features, you can even write an email. (Hint: see [package.json](package.json) for details, or go to the [website](http://beta.manonet.org))
For setting up the development environment see [README.md](README.md)
## Translations
Translations are very important, and I can't do them. If you speak any language other than Hungarian then you have perfect skills for translation contributions! You can translate the application interface, or you can simply review the existing translations, fix translation issues, bugs, typos, or grammar issues. At the moment I have 0 translators, so any help is a BIG help.
How to translate? Simple and easy! The user interface is managed in [POEditor](https://poeditor.com), a great translation management system, and in that way translation is even fun! Feel free to join under this link: [Join Translation of Manonet](https://poeditor.com/join/project/eIB3WJcqZ9)
Feel free to report or fix typos or grammar issues in the code-base too. (e.g. this file)
### My plan regarding translations
I have the following priority list in my mind if it goes about languages.
1. First thing first, the "default" language is **English**. Simply because it is the language of the internet and coding. I never really learned it, so there is definitely space for improvements.
2. **Hungarian** is the second default because this is my mother tongue. As simple as that.
3. I learned **German** in the school, so I added that language too. However, I am maybe the only one who understands my sentences, if you speak German, please review it.
4. As the first supported foreign languages, I plan to add European languages, like Slovak, Ukrainian, Romanian, Serb, etc. So languages, which have definitely unique keyboards, still have a smaller population. (In comparison to Russian for example.) It would be great to test the keyboard features, uncover bugs, and see if internalization really works.
5. My dream is to have the app also on **Russian** language. Russia is a big market. Very-very big market. No one will pay for the app, but still. I hope this dream comes true.
6. For sure, the next step is **French**, **Spanish**, **Italian**, and other European languages, which are used widely (because of historical reasons)
7. Other languages, which are spoken by some of my helpful friends.
Low priority languages
- Right to left languages. Sorry, it is not just about the translation, but more the layout, and first of all the app itself. It will be definitely a challenge. (or adding flex-direction: row-reverse; ...?)
- And of course ancient and extinct languages. Absolutely no time for that.
If you like to help in translation of **Any** language, just forget what I wrote. Join on the link or contact me.
#### Current status
- [![POEditor](https://img.shields.io/poeditor/progress/332969/hu?token=1aabd279b4b49d495134bbcff94c2199)](https://poeditor.com/projects/po_edit?id_language=65&per_page=50&id=332969) - Hungarian
- [![POEditor](https://img.shields.io/poeditor/progress/332969/en?token=1aabd279b4b49d495134bbcff94c2199)](https://poeditor.com/projects/po_edit?id_language=43&per_page=50&id=332969) - English
- [![POEditor](https://img.shields.io/poeditor/progress/332969/de?token=1aabd279b4b49d495134bbcff94c2199)](https://poeditor.com/projects/po_edit?id_language=55&per_page=50&id=332969) - German
## Bug reports
If you like to report a bug, you can do it on [GitLab](https://gitlab.com/zyxneo/typing/-/issues/new). You can follow the [guidelines of GitLab](https://about.gitlab.com/blog/2019/01/09/marker-io-gitlab-integration/) or similar.
## Coding contributions
If you want to add an issue or pull request, please ensure that the existing issues don't already cover your question or contribution. It is recommended to get in touch before you start coding.
[![pipeline status](https://gitlab.com/zyxneo/typing/badges/dev/pipeline.svg)](https://gitlab.com/zyxneo/typing/commits/dev)
[![coverage report](https://gitlab.com/zyxneo/typing/badges/dev/coverage.svg)](https://gitlab.com/zyxneo/typing/commits/dev)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![devDependency Status](https://david-dm.org/electron/electron/dev-status.svg)](https://david-dm.org/manonet/typing?type=dev)
[![pipeline status](https://gitlab.com/zyxneo/typing/badges/dev/pipeline.svg?style=flat)](https://gitlab.com/zyxneo/typing/commits/dev)
[![coverage report](https://gitlab.com/zyxneo/typing/badges/dev/coverage.svg?style=flat)](https://gitlab.com/zyxneo/typing/commits/dev)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat)](https://github.com/prettier/prettier)
[![GitHub last commit](https://img.shields.io/github/last-commit/manonet/typing.svg?style=flat)](https://gitlab.com/zyxneo/typing/-/commits/dev)
[![GitHub package.json version](https://img.shields.io/github/package-json/v/manonet/typing.svg?style=flat)](package.json)
# Manonet Typewriter Program
Prototype: [http://beta.manonet.org](http://beta.manonet.org)
[![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m784822203-4a75e480b59a8468777aa7de.svg?style=flat)](https://uptimerobot.com/dashboard#784822203)
[![Website](https://img.shields.io/website?url=http%3A%2F%2Fbeta.manonet.org?style=flat)](http://beta.manonet.org)
This is a React app made with [Gatsby](https://www.gatsbyjs.org/) framework.
This is a [React](https://reactjs.org/) app made with [Gatsby](https://www.gatsbyjs.org/) framework.
[![devDependencies Status](https://david-dm.org/manonet/typing/dev-status.svg?style=flat)](https://david-dm.org/manonet/typing?type=dev)
## Contributing
If you are interested in reporting/fixing issues and contributing directly to the code base, please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
---
### Links
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment