Skip to content

How to contribute

Jump to bottom
Aida Enna edited this page Feb 24, 2019 · 2 revisions

Common Github Terminology

Repository: This is where all the patch files are. Our repo (short for repository) is https://github.com/Arks-Layer/PSNovaTranslations.

Fork: A fork is a copy of our repo that is saved under your name. Example: https://github.com/Aida-Enna/PSNovaTranslations.

Pull Request: This is a request for us to look at your awesome translations. It shows the difference between your fork and the main repo, so we can discuss changes and stuff. (Typically called a PR for short)

Merging: This is what happens when your PR is approved - Your changes are brought into the main repo and will be in the next build of the patch.

If you'd like more information about how Github works, feel free to take the highly recommended tutorial here: https://guides.github.com/activities/hello-world/

Getting started

Quick overview of the process: The way it works is that we have a "repository" with all the patch files in it - You make your own "fork" (version of it) and edit the fork. Once you've made your edits to your fork, you send a "pull request" (a request for us to look at your awesome translations), and then we "merge" them (put it in the main patch).

Making Your Own Fork

This part will only have to be done once - Go to https://github.com/Arks-Layer/PSNovaTranslations and click the "Fork" button in the top right. This will create a copy of the repo in your name. For example, if my username was "AidasTutorialAccount", my fork would be available at https://github.com/AidasTutorialAccount/PSNovaTranslations.

This fork is what you will edit in the next step.

If you are more comfortable editing local files with an editor like Notepad++, it's recommended to make a local fork as well. Click below for instructions on how to do it.

Creating a local copy of your fork (Advanced) For this, we'll be using Github Desktop. This program will download a local copy of the repo to your system, and will sync the changes you make to the files with your online fork.
  1. Download it from https://desktop.github.com/
  2. Once you've opened it, click "Sign into Github.com". Enter your username and password.
  3. Then enter the name you'd like to be displayed, and your email.
  4. On the online fork you made under your name, click the green "Clone or download" button on the main page. Click the clipboard icon next to the text to copy it. (It should be something like "https://github.com/AidasTutorialAccount/PSNovaTranslations.git" with your name instead of AidasTutorialAccount).
  5. In Github Desktop, click "Clone a repository" and enter the copied text for the URL box. Then hit "Clone".

Congrats, you've made a local copy of your online repo! \ o /

Finding Text To Translate/Edit

There's several different methods to edit the files. Each person prefers a different method. I'll detail the most common ones here.

Scenario: We've found some untranslated text in the story:

現に今、フォトンが使えない状況だ。
こうなると生身の体力は重要だぞ。

We copy the first sentence from the chatlog. If it's not copy-able, you can take a screenshot and use some OCR programs to read it for you (or draw the characters using Google Translate). Now that we have the text, we have to find out what file it's in.

On the PSO2 Discord (http://discord.gg/PSO2), we go to the #vita-psnova room and type "~nsearch そうでもないさ。".

This tells us that the text we want to translate is in the "Story 1.json" file.

Finding/Editing/Translating The Files

1) Using GitHub's Online Editor (Easy)
  1. In your online fork's main page, click "Find File" and paste the file you're looking for, "Story 1.json".
  2. Click the result and you'll be taken to the file's page. For instance, this file should be in https://github.com/AidasTutorialAccount/PSNovaTranslations/blob/master/rmd/Story%201.json (Replacing AidasTutorialAccount with your username)
  3. Now, this section is translated, but if it were not, it would look like this:
  "101020060100004": 
    "OriginalText": "そうでもないさ。\n現に今、フォトンが使えない状況だ。\nこうなると生身の体力は重要だぞ。"
    "Text": ""
    "Enabled": true
  1. Click the pencil icon () and you'll open the Github Online Editor. You'll write your translation in between the quotes in Text (additional formatting information is available below) like so:
  "101020060100004": 
    "OriginalText": "そうでもないさ。\n現に今、フォトンが使えない状況だ。\nこうなると生身の体力は重要だぞ。"
    "Text": ""
    "Enabled": true
  1. Type a short summary at the buttom, and hit Commit Changes.
  2. The file will be changed with your translation. This does NOT mean it is in the patch yet! You'll need to create a PR in the next section first.
2) Using a local copy of your fork (Advanced)
  1. Find the local file that you want to edit. In this case, it's "Story 1.json", which is wherever your repo was saved, then in the /rmd/ folder.
  2. Now, this section is translated, but if it were not, it would look like this:
  "101020060100004": 
    "OriginalText": "そうでもないさ。\n現に今、フォトンが使えない状況だ。\nこうなると生身の体力は重要だぞ。"
    "Text": ""
    "Enabled": true
  1. Open the file with an editor (We recommend Notepad++) and make your edits. You'll write your translation in between the quotes in Text (additional formatting information is available below) like so:
  "101020060100004": 
    "OriginalText": "そうでもないさ。\n現に今、フォトンが使えない状況だ。\nこうなると生身の体力は重要だぞ。"
    "Text": ""
    "Enabled": true
  1. Save the file and go back to Github Desktop.
  2. Click the "Changes" tab (select your repository if it's not selected) and type a short summary of what you've done. Then click "Commit to EN".
  3. Once this completes, you'll need to click "Push Origin" in the top center/right area. This will sync your changes to your online fork. This does NOT mean it is in the patch yet! You'll need to create a PR in the next section first.

Creating A Pull Request (Sending Us Your Work)

The final step in this process is sending us a PR with your changes. You can edit things and change them after submitting a PR, it will automatically be updated with new changes you make until it's merged.

  1. Open your Fork's main page
  2. Click "Pull Requests" at the top
  3. Click "New Pull Request"
  4. Look over your changes and make sure everything is as you want it, then click "Create Pull Request".
  5. Give it a title and write a summary of the changes and anything else you need to explain.
  6. Once you're ready, click "Create pull request" and it'll be sent to us and posted in the #vita-psnova room.
  7. Someone from the team will look over it, comment on anything that needs to be fixed or what fails, and eventually merge it into the patch if everything works out.

Congratulations, you've helped work on the PS Nova English patch! Your changes will show the next time the patch is built. Thank you very much! \o/

Clone this wiki locally