Giter VIP home page Giter VIP logo

happyshield.github.io's Introduction

happyshield.github.io Contribution Guide

Translations

Introduction

Thanks for your help translating the HappyShield website and instructions!

We hope to translate the following files in this website (XX is the ISO 639-1 code for the language):

* index_XX.md (Homepage)
* Instructions/HandCreasing/handCreasing_XX.md (Hand creasing method instructions)
* Instructions/LaserCut/laserCut_XX.md (Laser-cut method instructions)
* Instructions/LaserCutAndPressureCreasing/laserCutAndPressureCreasing_XX.md (Laser-cut and pressure-creasing method instructions)
* Instructions/WaveShield/waveShield_XX.md (WaveShield production method instructions)

Instructions

Here's how to contribute translations!

1. Create a Free GitHub Account

  1. Create a free GitHub account. (If you sign up using an academic email address you are eligible for a free 2-year upgrade to GitHub Pro, but this is not necessary for creating and editing translations to happyshield.github.io).
  2. Navigate to this repository, making sure that you are viewing the main version of the repository: "HappyShield/happyshield.github.io"

To translate (or edit an existing translation):

2. Create and Edit Translation Files

Watch our video explaining how to create and edit translations files for HappyShield.Github.io here!

The instructions are also shown below:

If the translation file already exists:
  1. Navigate to the relevant file in this repository.
  2. Click "Edit this File"
  3. Type any changes you would like to make to the text in the file.
  4. Add a description explaining the changes you have made.
  5. Commit the changes ("Propose File Change")

You can also see this process explained nicely here! https://guides.github.com/activities/hello-world/#commit

If the translation file does not yet exist:
  1. Navigate to the English version of the file (for example: Instructions/HandCreasing/handCreasing_EN.md) which you will be translating into another language.
  2. Click the edit button.
  3. Select all of the text in the file and copy it.
  4. Close the file. You should have made no changes, so no commit is necessary.
  5. Navigate to the folder where the file should exist.
  6. Click create new file, and choose the appropriate name: Instructions/HandCreasing/handCreasing_TR.md for "Hand Creasing" instructions in Turkish (TR), for example.
  7. Paste.
  8. Edit this text, replacing English with your translated text.
  9. If you want to save your progress at any point, commit the changes, and provide a description of the changed made since the previous commit.

3. Submit a Pull Request for Your Translation

When you are ready for your work to be incorporated into the main repository, you will submit a pull request, which is a request to have these changes incorporated into the live website.

Watch our video explaining how to submit a pull request for your translations files for HappyShield.Github.io here!

The instructions are also shown below:

  1. Click Pull Request.
  2. Click Create Pull Request
  3. Add any helpful description along with your Pull Request to explain to others what you have added or changed to the text.
  4. Submit your Pull Request.

Auri (or whoever is managing the repository!) will review and approve the pull request, and then merge these into the main repository, where they should be rendered on the live website within 3-5 minutes. : )

happyshield.github.io's People

Contributors

aurimasmb avatar happyshield avatar gw372 avatar antiopikoronaki avatar anagatoo avatar wesamasali avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.