Skip to content

Latest commit

 

History

History
207 lines (153 loc) · 6.61 KB

Translating-Github-Cheat-Sheet.md

File metadata and controls

207 lines (153 loc) · 6.61 KB
Raw

Translating GitHub Cheat Sheet

Preparation

Install Git

  1. Install Git based on what operating system you have
  2. Add your identity to your git environment. (If you use an email associated with your GitHub account your profile will show a heat map of your commit activity).
git config --global user.name "John Doe"
git config --global user.email [email protected]

NOTE: Use quotations around your name because of the space.

Fork The Repository

  1. Navigate to Mastodon's GitHub Page
  2. Click Fork in the top right.
  3. There will now be a copy of the repository on your account.

Start Translating

Clone The Repository

  1. Open Terminal on your computer and navigate to a place where you want to store the project using cd (ex. cd ~/Documents)
  2. Download a copy of the project using
git clone https://github.com/YOURUSERNAME/mastodon
  1. Add the original mastodon repository as upstream
git remote add upstream https://github.com/tootsuite/mastodon.git
  1. Branch out to translate. It is recommended to replace locale with RFC5646 language tag of you language:
git checkout -b locale
  1. Write your awesome translations following the translating guide

Push To Your Repository

  1. Open Terminal and navigate to where you stored mastodon (ex. cd ~/Documents/mastodon)
  2. Type git status to see files you have modified or added.
  3. We need to add those to the commit we're about to make and we can add them all at once with
git add .
  1. We can commit everything to our local copy with
git commit -m "YOUR MESSAGE HERE"

You'll want to make your commit message something short, but meaningful as it's visible to everyone. A good example would be, "Added French localization". 5. Now you can push your changes to your remote copy of mastodon using

git push

Pull Request

  1. Click this to start a new pull request, or navigate to Mastodon's GitHub Page, click Pull requests, and New pull request
  2. On the Compare Changes page you will want to click compare across forks
  3. The base fork should be tootsuite/mastodon:master and the head fork should be YOURUSERNAME/mastodon:YOURBRANCH. This will show you a summary of changed files.
  4. Click Create pull request and explain your changes.

Finished

Congratulations! Your pull request will be reviewed for merging into the repository.

If you had any questions or confusions during this process please submit a documentation issue or pull request clarifying confusing areas.

If things get overwhelming, copy out your translation work, delete the project locally, remove the fork from your account, and start the process over again.

If you would prefer to not work in a Terminal, there are GUI clients available for git.

Carry on Translations

OK. You have finished your translation long time ago. And Mastodon improved over time. Now you want to update the translation.

There have been some time before your last work. Although you have a copy of the source code, but it is just an outdated version.

In you idle time,

  • some other people could have added translations to your language;
  • structure of the translation file could have been changed.

You'll need to clean up your workspace to work. Naturally you need to:

  1. Get the latest source code
  2. Branch out again
  3. Work on your translation
  4. Push to your repository
  5. Pull Request

Get the Latest Source Code

1. Make sure you have the upstream bookmark right.

If you're not sure, run this:

git remote add upstream https://github.com/tootsuite/mastodon.git

If you get the following message, ignore it:

fatal: remote upstream already exists.

To verify, you can run this:

git remote get-url upstream

The output should be:

https://github.com/tootsuite/mastodon.git

2. Fetch source code from upstream

git fetch upstream master

The output should be:

From https://github.com/tootsuite/mastodon
 * branch            master     -> FETCH_HEAD

3. Sychronize your master branch with Mastodon's master branch

git reset --hard upstream/master

The output should be something similar to this:

HEAD is now at abcd123 Some commit message

Branch Out Again

1. Decide the branch name

It is recommended to use RFC5646 language tag as your translation branch name. If not sure, use locale as the branch name.

2. Remove existing branch, if any.

git branch -D BRANCHNAME

If you get a message similar to either of the below ones, you're fine:

error: branch 'BRANCHNAME' not found.

or

Deleted branch BRANCHNAME (was abcd123).

3. Branch out from master

git checkout master
git checkout -b BRANCHNAME

Work on your translation

Write your awesome translations following the translating guide

Push to your repository

1. Review the Changes to Push

Open Terminal and navigate to where you stored mastodon (ex. cd ~/Documents/mastodon)

Type git status to see files you have modified or added.

We need to add those to the commit we're about to make and we can add them all at once with

git add .

2. Create a Commit of the Changes

We can commit everything to our local copy with

git commit -m "YOUR MESSAGE HERE"

You'll want to make your commit message something short, but meaningful as it's visible to everyone. A good example would be, "Added French localization".

3. Upload the Changes in the Commit

Now you can push your changes to your remote copy of mastodon using

git push

Pull Request

  1. Click this to start a new pull request, or navigate to Mastodon's GitHub Page, click Pull requests, and New pull request
  2. On the Compare Changes page you will want to click compare across forks
  3. The base fork should be tootsuite/mastodon:master and the head fork should be YOURUSERNAME/mastodon:YOURBRANCH. This will show you a summary of changed files.
  4. Click Create pull request and explain your changes.