Skip to content

Latest commit

 

History

History
68 lines (42 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

68 lines (42 loc) · 2.16 KB
Raw

Contributing New Translations

Step 1 - Fork the repository

Click the Fork button in the top-right.

Fork button

Step 2 - Clone the repository to your computer

cd ~/Documents
git clone [email protected]:YOUR_NAME/scratch-curriculum.git
cd scratch-curriculum

NB: Replace YOUR_NAME with your GitHub handle and Documents with whatever folder on your machine you’d like to keep your work in.

Step 3 - Create a folder for your translation

Copy the 'en-GB' folder and rename it appropriately e.g. 'es-ES'.

cp -r en-GB es

Step 4 - Translate!

You can translate anything and everything you like within your translation folder. This means folder names, file names, and the contents of the Markdown, PDF and Scratch files.

Step 5 - Push your work

When you’re happy with your translation, run the following commands to commit and push your work:

cd ~/Documents/scratch-curriculum
git add --all
git commit -m 'Your message here, e.g. Add Spanish translation'
git push

Step 6 - Make a pull request

Click the Pull Request button.

Pull request

Give your pull request an appropriate message.

Pull request message

Step 7 - Ask another native speaker to review your pull request

Give another native speaker a link to your pull request, which will be something like http://github.com/codeclub/scratch-curriculum/pull/3

If they’re happy, they should leave a comment on the pull request with a :+1: or similar message.

Step 8 - We merge the translation!

We’ll only merge in complete translations, but we encourage people to make pull requests from work-in-progress translations so that others can comment and contribute.

When we do merge the pull request, your translation will become part of the repository, available for everyone to use and benefit from, and we’ll say thank you and give you a massive hug.

Thank you