create explanation for contributors

CONTRIBUTING.md

@@ -0,0 +1,114 @@
+# Contribute to the Interslavic Dictionary project
+
+First of all, thanks for taking the time to contribute.
+
+Here you can discover how you can help the project and find the [guidelines](#guidelines) for your contribution type.
+
+* [Fix a wrong or a missing translation](#fix-a-translation)
+* [Fix an incorrect word form](#fix-word-form)
+* [Fix a bug in the user interface](#fix-ui-bug)
+* [Add a new feature](#add-a-feature)
+* [I have something else...](#something-else)
+
+If you need to check a particular [HOW-TO](#how-to), below is a small table of contents for your convenience:
+
+* [Obtaining write access to Google Spreadsheets](#google-spreadsheets)
+* [Local environment setup](#local-environment-setup)
+
+# Guidelines
+
+<a id="fix-a-translation"></a>
+## Fix a wrong or a missing translation
+
+You wish to fix a missing (automatic) translation, or the translation is inaccurate or incomplete, e.g.:
+
+![An example of a missing translation](docs/assets/ui-example-translation.png)
+
+![An example of an incorrect translation](docs/assets/ui-example-wrong-dvoje.png)
+
+This repository does not store the translations themselves; they are located and maintained at Google Sheets [here](https://docs.google.com/spreadsheets/d/1N79e_yVHDo-d026HljueuKJlAAdeELAiPzdFzdBuKbY). Leave a comment to the document or see [Obtaining write access to Google Spreadsheets](#google-spreadsheets).
+
+<a id="fix-word-form"></a>
+## Fix an incorrect word form
+
+![An example of an mistaken inflection](docs/assets/ui-example-wrong-conj.png)
+
+![An example of an error in inflection](docs/assets/ui-example-wrong-conj-missing.png)
+
+First of all, [open an issue](#opening-an-issue) to get initial feedback and consensus on the correct word forms.
+
+If you feel confident enough around JavaScript code, you could try fixing the problem yourself, here is the workflow:
+
+1. [Set up the repository locally](#local-environment-setup).
+1. Align the test snapshots with the up-to-date dictionary contents from Google Sheets using `npm run updateTestSnapshot` and `git commit` the changed files.
+1. Edit the code responsible for word inflection — most likely you'll need [this folder](https://github.com/scherebedov/interslavic/tree/master/src/legacy).
+1. Run the unit tests and review the errors — that way you'll see what the scope of your change is.
+1. Once you are sure that your change fixes the issue and does not create any new ones, make another Git commit with your fix and the updated snapshots (yes, run `npm run updateTestSnapshot` for the second time).
+1. Create a pull request and pass the review process to get it merged.
+
+<a id="fix-ui-bug"></a>
+## Fix a bug in the user interface
+![Fixing an incorrect interface element](docs/assets/ui-example-wrong-plural.png)
+
+See: [opening an Issue](#opening-issue)
+
+If you want to track and fix the problem yourself, you should look into [local environment setup](local-environment-setup). Having some knowledge of TypeScript and React framework would help here.
+
+<a id="add-a-feature"></a>
+## Add or request a new feature
+
+We conform to the usual git workflow ('gitflow'). If you have a proof-of-concept, feel free to create a pull request; otherwise, open an issue.
+
+<a id="something-else"></a>
+## I have something else...
+
+# HOW-TO
+
+<a id="google-spreadsheets"></a>
+## Obtaining write access to Google Spreadsheets
+
+You should go straight to the [new_interslavic_words_list](https://docs.google.com/spreadsheets/d/1N79e_yVHDo-d026HljueuKJlAAdeELAiPzdFzdBuKbY) document in _Google Sheets_ and request edit access:
+
+![Request edit access](docs/assets/gsheets-request-access.png)
+
+In the text area you should briefly describe what translation issue you have found, and also specify what languages you know at level of a native speaker to get edit access to the respective translation columns:
+
+![Ask owner form](docs/assets/gsheets-ask-owner.png)
+
+When you gain the access, open a comment at the respective spreadsheet cell that contains the translation issue, or edit that cell yourself in case when the issue is minor and trivial.
+
+Please join the work on improving word translations for your native language!
+
+<a id="issue"></a>
+## Opening an issue
+
+<a id="local-environment-setup"></a>
+## Local environment setup
+
+You need to perform the following steps:
+
+1) Install `node.js`: https://nodejs.org/en/download/
+
+The next steps should be done with the help of command line interface.
+
+2) run `git clone https://github.com/scherebedov/interslavic`
+
+3) run `npm install` inside the directory created
+
+4) `npm run generateDictionary`
+
+5) `npm start` (`Ctrl+C` to stop)
+
+6) Navigate to `localhost:3000` or  `http://0.0.0.0:3000/` in your browser.
+
+The code changes should take effect after refresh (`F5`). In some cases, it could be necessary to repeat `npm install` and/or `npm start` commands.
+
+## Code of Conduct
+
+See [Contributor Covenant](https://www.contributor-covenant.org/translations).
+
+## Project maintainers
+
+The Interslavic Dictionary project maintainers are the people accepting or rejecting any PR.
+Although anyone can review PRs, only the acknowledgement from an Approver counts towards the approval of a PR.
+This repository is configured to require one approval from the repository-specific approval team before a PR can be merged.

CONTRIBUTING.sla-Latn.md

@@ -0,0 +1,93 @@
+# Pomoži proektu Slovnika Medžuslovjanskogo jezyka!
+
+Najprvo, my blagodarimo tebe za ohotu pomogti s razvivanjem slovnika. 
+
+Tut ty možeš srazuměti, jak pomogti proekty i najdti [direktivy](#guidelines) ob različnyh vkladah:
+
+* [Ja vidžu pogrešku v prěkladu](#fix-a-translation)
+* [Ja vidzu pogresku v sklonjenjah ili v spreženjah](#fix-word-form)
+* [Ja vidzu pogrešku v interfejse](#fix-ui-bug)
+* [Ja hču poprositi ili izdelati novu možlivost](#add-a-feature)
+* [I have something else...](#something-else)
+
+Ako li ty hočeš pročitati někuju rady ob [JAK-IZDELATI](#how-to):
+
+* [Jak dobyti pravo redagovati Gugl Tabely](#google-spreadsheets)
+* [Jak instalaciti i izměnjati slovnik na mojem kompjutere](#local-environment-setup)
+
+<a id="guidelines"></a>
+# Direktiva
+
+<a id="fix-a-translation"></a>
+## Ja vidžu pogrešku v prěkladu
+
+Prěklady mogut byti ne prověrjenymi (byti avtomatičnymi), ili byti nepravilnymi/necělkovitymi.
+
+![An example of a missing translation](docs/assets/ui-example-translation.png)
+
+![An example of an incorrect translation](docs/assets/ui-example-wrong-dvoje.png)
+
+Vsi prěklady uměščeny v Gugl Tabelah (Google Spreadsheets: <<LINK>>). Najlěpša metoda napraviti prěklad --- ostaviti tam komentar. Takože ty može stati redaktorom, gledi [Jak dobyti pravo redagovati Gugl Tabely](#google-spreadsheets).
+
+<a id="fix-word-form"></a>
+## Ja vidzu pogresku v sklonjenjah ili v spreženjah
+
+![An example of an mistaken inflection](docs/assets/ui-example-wrong-conj.png)
+
+![An example of an error in inflection](docs/assets/ui-example-wrong-conj-missing.png)
+
+Gledi: [otvorjenje kvestiji](#issue)
+
+Ci ty hočeš li popraviti tuto sam? Kod, odgovorny/odpovědalny za tutu možlivost, nahoditi se [tam](https://github.com/scherebedov/interslavic/tree/master/src/legacy). My imajemo nadeju, že on jest razumliv bez velikogo znanja programovanja.
+
+<a id="fix-ui-bug"></a>
+## Ja vidzu pogrešku v interfejse.
+![Fixing an incorrect interface element](docs/assets/ui-example-wrong-plural.png)
+
+Gledi: [otvorjenje kvestiji](#issue)
+
+Ako li ty hočeš najdti i počiniti pogrešku sam, tebe se povinno pročitati ob [lokalnoj instalaciji](local-environment-setup). Budet pomočnostju uměnje koristati TypeScript i opravu React.
+
+<a id="add-a-feature"></a>
+## Ja hču poprositi ili izdelati novu možlivost
+
+My pracujemo v paradigmu git workflow ('gitflow'). Ako li ty imaješ prototip, sotvori `pull request`; jestli ne, togda tebe potrebno izdelati kvestiju (`issue`).
+
+# JAK IZDELATI...
+
+## Jak instalaciti i izměnjati slovnik na mojem kompjutere?
+
+Povinno se naslědny kroki sovršiti:
+
+1) izdelati instalaciju node.js: https://nodejs.org/en/download/
+
+Naslědny kroki potrebno delati v konsoli/terminale.
+
+2) izdelati `git clone https://github.com/<<>>/interslavic`
+
+3) vnutri tutoj direktorii izdelati `npm install`
+
+4) `npm run generateDictionary`
+
+5) `npm start`
+
+6) idi v brauzere do `localhost:3000` ili  `http://0.0.0.0:3000/` (`Ctrl+C` za postojku)
+
+Posle popravok koda potrebno osvěžiti stranicu brauzera (`F5`). Poněkogda može potrěbovati si povtarjati `npm install` i `npm start`.
+
+
+<a id="google-spreadsheets"></a>
+## Jak dobyti pravo redagovati Gugl Tabely?
+
+My zovemo tebe v tutoj document: [new_interslavic_words_list](https://docs.google.com/spreadsheets/d/1N79e_yVHDo-d026HljueuKJlAAdeELAiPzdFzdBuKbY). Potom poprosi dostup na redagovanje:
+
+![Request edit access](docs/assets/gsheets-request-access.png)
+
+In the text area you should briefly describe what translation issue you have found, and also specify what languages you know at level of a native speaker to get edit access to the respective translation columns:
+
+![Ask owner form](docs/assets/gsheets-ask-owner.png)
+
+When you gain the access, open a comment at the respective spreadsheet cell that contains the translation issue, or edit that cell yourself in case when the issue is minor and trivial.
+
+Please join the work on improving word translations for your native language!
+