Files
Pupil/README.md
2020-10-13 17:33:39 +09:00

49 lines
1.6 KiB
Markdown

# Tag translation
Tags will be updated every day at 00:00 UTC
## License
Check [LICENSE](https://github.com/tom5079/Pupil/blob/tags/LICENSE.md)
## Participating in tag translation
[한글 설명서](https://github.com/tom5079/Pupil/blob/tags/docs/README-ko.md)
### Rules
* Each translation file should be located in the root folder
* Each translation file should be named in following format: [`<ISO 639-1 Code>.json`](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
* Each translation file should be formatted as JSON file
### 1. Access Editor
### 1-1. (Optional) Add language file
If the target language file doesn't exist, you have to create one.
1) Click `Create New File` Button at the upper right corner
![](https://github.com/tom5079/Pupil/blob/tags/docs/images/add-file.PNG?raw=true)
2) Name the file according to the naming rule
![](https://github.com/tom5079/Pupil/blob/tags/docs/images/filename.png?raw=true)
3) Copy-paste all the content of [`template.json`](https://raw.githubusercontent.com/tom5079/Pupil/tags/template.json)
### 1-2. Edit Existing File
Click the file to edit and click Pen icon located at the upper right corner
![](https://github.com/tom5079/Pupil/blob/tags/docs/images/edit-file.png?raw=true)
### 2. Make Necessary Changes
Use text editor shown on screen to make changes
### 3. Propose Changes
When you're done with your changes, Scroll down to the bottom of the page and click `Propose Changes`
You don't have to provide any commit messages
![](https://github.com/tom5079/Pupil/blob/tags/docs/images/propose-changes.png?raw=true)
The changes will be applied after review