Translations for Braytech.org
This file describes how to contributing translations to this repo. It has three guides:
- TL;DR for experienced users;
- online a.k.a. easy translation for newbies who want to help but not to dig into git stuff;
- with local repo a.k.a. pro geek for newbies who are ready for everything.
-
Fork the repo.
-
Add translations by changing the lines started with 🦘 (delete roo emoji after translation).
-
Create a pull request.
-
First of all if you don't have a GitHub account create a GitHub account.
-
In this repo open the folder with you language and click on translation file. On top right angle find an edit icon and click it.
-
Find the line with 🦘 and translate it. Make sure to delete english text and roo emoji when done. Repeat.
-
At the bottom of the page you will find a section where you can title changes and provide a short description. After that press "Propose changes" button.
-
You will be shown where you are going to transfer data and the list of lines changed. You need to click Create pull request button. You should see These branches can be automatically merged line. If not, ask Tom or translation team in discord.braytech.org Press Create pull request button once more after that.
-
Wait until Tom checks it and confirms the merge.
-
First of all if you don't have a GitHub account create a GitHub account.
-
You can't make changes directly to this repository, so you need to fork it to your page.
-
You can edit translations online or download repo files to your PC.
-
There're different software used to work with git on PC, we recommend VS Code as an all-in-one tool.
-
After installing and opening VSCode select Clone repository.
-
Here you can sign into your GitHub account. Do it.
-
Then click on the repo name (it will be like yourGitAccountName/braytech.org-translations) and select a folder on your PC where to save the repo files.
-
After downloading the files VS Code will suggect you actions in right bottom corner. Click "Open".
-
Here I recommend you to install Git Graph extention. It will help you a lot to understand the flow of changes. Click on "Extentions" tab on left and search for
git graphthen click "Install". -
Here you'll see a new icon in explorer tab. Click on it.
-
You see the history of all changes to this repository. Who, when and the subject itself.
-
Now you need to configure git in order to make everything easy. Top right corner of git graph tab has a settings icon.
-
Two important areas here.
-
First of all User Details. You need to set your GitHub account name so that other users can match your GitHub account to your commits. You may not set email if you want it to be private. If you do, anyone can see it.
-
The second, but no less important. I recommend you to add Remote Configuration to this repo (right now you have only your fork there). This will allow you to be aware of changes in parent repo. Use button "Add remote" and fill the "Fetch URL" filed with
https://github.com/justrealmilk/braytech.org-translationsAlso I advise you to rename remotes so that you can easily identify them. Use "Edit" button for that. -
Not so important, but very usefull. Pull Request Creation. Click "Configure" and set source to your fork and destination to toms. Second step just for checking data. Save.
-
All the settings we did are handled by VS Code and stored in the project folder. So you do not have to repeat them every time you open VS Code.
-
From here on I'm going to tell about the translation process.
-
First af all, when you decide you update few lines, you need to check if there're any new lines in repo. This can be done by clickling fetch buttom in top right corner of git graph.
-
After that you need to merge the last avaliable commit (this is the name of a single contribution to the repo) to your branch. Click right mouse button on branch label and select "Merge into current branch". This will bring the last data from tom's repo to the brach in your fork so you can start translation.
Here you uncheck creating commit and then merge.
-
Find the line with 🦘 and translate it. Make sure to delete english text and roo emoji when done. Repeat. Save file.
-
On the left panel (Explorer -> Source Control) you'll see that there are unstaged changes in files. You should click "Stage Changes" (1 on the image below), add short description to the changes (2) and then click "Commit" button (3).
-
Click Synchronize changes in the left bottom corner of VS Code. This'll bring your commit to your GitHub web account.
-
Now you need to send your commits to this repo. In line 16 we were configuring pull requests, so now you can just use it. Click right mouse button on your branch label in git graph and select "Create Pull Request". You may be asked a question if you want to push branch first you can do that (this is almost the same as sync buttom from line 23) and then a web browser page will be opened.
-
On the web page you'll be shown from which branch to which you are going to transfer data, the list of commits affected and lines changed. You need to click button Create pull request and then you can text short title and description. There have to be line These branches can be automatically merged. If not consult Tom or translation team in discord.bray.tech Press button Create pull request once more after that.
-
Now all there's left for you to do is to wait until Tom checks it and confirms the merge.