-
-
Notifications
You must be signed in to change notification settings - Fork 92.9k
Description
Hi @Technozamazing,
Thank you for looking into the differences between Traditional Chinese and English translations. That's the spirit we want.
We want all translations to be aligned with main Readme.md.We had a pull request that recently got merged to address some of these differences. https://github.com/firstcontributions/first-contributions/pull/98856/files
If there's more to do, please open a new issue pointing out all the differences that needs to be fixed. If you want to, submit a PR to address it too.
Originally posted by @Roshanjossey in #104826
🐞 Problem
The Traditional Chinese translation is not aligned with the English Readme, there are various differences, including omitted or incorrect directions, readability and semantic errors.
🎯 Goal
Remove the incorrect directions and translation errors, enhance readability, make sentences coherent.
💡 Possible solutions
I've compare and gathered the significant and moderate differences between the English Readme and translated version in Traditional Chinese (referred to below as En and zh-tw for the two respectively). This is a long list, please go through it in this order, the Significant Differences
-> the mentioned PR -> the Moderate Differences
(if you are interested in reasons) -> the Minor Differences
.
The reason for listing the two (significant and moderate differences) separately is because this is a lot. By doing so, the significant ones can be addressed and not lost in the wall of text. Even if this issue is not merged for various reasons, hopefully the significant ones can be addressed in the future.
Following is the list of differences, I will first describe which sentences in which section I am talking in En, then translated content (if important), finally the reason of change.
Significant Differences
Differences that go beyond readability and semantic errors, include omitted or incorrect directions.
- In the Clone the repository section:
Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button, then on SSH tab and then click the copy url to clipboard icon.
The above text is from En, the following is zh-tw translated back to English.Next, copy the copied repository on to your computer. Click the green button as image shown, then click the copy to clipboard button (to copy the repository URL).
In zh-tw, there are directions missing and errors:Go to your GitHub account, open the forked repository
part.SSH tab
part.copied repository
should beforked repository
, ascopy the copied repository
doesn't make sense.
git clone git@github.com:this-is-you/first-contributions.git
the above command is from En, the following is from zh-tw.git clone https://github.com/<this-is-you>/first-contributions.git
, zh-tw has the wrong URL.
- In the Make necessary changes and commit those changes section,
Now open `Contributors.md` file in a text editor, add your name to it. Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file.
The above text is from En, the following is zh-tw translated back to English.Open the `Contributors.md` file with the editor to your liking, add your name to the bottom of the file, and save it.
In En the name is added to the middle of the file, but in zh-tw the name is added to the bottom of the file. - In Push changes to GitHub, error message in collapsible section,
fatal: Authentication failed for 'https://github.com//first-contributions.git/'
, in the source code it isfatal: Authentication failed for 'https://github.com/<your-username>/first-contributions.git/
, the<your-username>
part is missing. Replace<
with<
solves the issue, as suggested here.
Note that this effects all translated version of README that has this collapsible section. However, this also introduces inconsistencies within En, since nowhere in it uses<>
to emphasize part of text.
Moderate Differences
Differences within readability and semantic errors.
- In the "First Contributions" section, the text style formatting is not aligned:
If you're not comfortable with command line, here are tutorials using GUI tools.
The above text is italic in En, bold and italic in zh-tw. zh-tw have the option to be hyperlinked, En didn't.If you don't have git on your machine, install it.
The above text is bold in En, no style formatting in zh-tw. En have the option to be hyperlinked, zh-tw didn't.
- In the Clone the repository section, the text style formatting is not aligned, missing punctuation, different methods is used to emphasize part of git commands:
Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button, then on SSH tab and then click the copy url to clipboard icon.
The above text is from En, the following is zh-tw translated back to English.Next, copy the copied repository on to your computer. Click the green button as image shown, then click the copy to clipboard button (to copy the repository URL).
In zh-tw:copy url to clipboard
should be in italic.- Is missing period at the end of paragraph.
git clone git@github.com:this-is-you/first-contributions.git
the above command is from En, the following is from zh-tw.git clone https://github.com/<this-is-you>/first-contributions.git
zh-tw has an extra angle brackets (<>
) aroundthis-is-you
.where `this-is-you` is your GitHub username.
The above text is from En, the following is from zh-tw.'this-is-you' 指的就是你/妳的 GitHub 用戶名。
In Enthis-is-you
is surrounded by single backticks (`), In zh-twthis-is-you
is surrounded by single quotation marks (').
- In the Create a branch section, wrong punctuation, incorrect translation, extra punctuations around part of git commands, missing collapsible section:
Change to the repository directory on your computer (if you are not already there):
in zh-tw, the text in parentheses is missing, and punctuation at the end of sentence is period not colon.Now create a branch using the `git switch` command:
the above text is from En, the following is zh-tw translated back to English.Next, use the `git switch` command to create a code branch:
. In zh-tw uses程式碼分支
(translated tocode branch
), branch should be translated as分支
, as in the title of this section, not程式碼分支
.git switch -c your-new-branch-name
the above command is from En, the following is from zh-tw.git switch -c <add-your-name>
. The git command in zh-tw uses a different placeholder name, and has an extra angle brackets (<>
) aroundadd-your-name
.If you get any errors using git switch, click here:
the above text is from En and is missing from zh-tw (the whole collapsible section).
- In the Make necessary changes and commit those changes section, text wrap formatting cause git command hard to read, wrong or missing punctuation, extra punctuations around part of git commands:
If you go to the project directory and execute the command git status, you'll see there are changes.
The zh-tw text wrap are positioned differently, andgit add
command are harder to read due this.Add those changes to the branch you just created using the `git add` command:
in zh-tw the punctuation at the end of sentence is period not colon.Now commit those changes using the `git commit` command:
in zh-tw the punctuation at the end of sentence is period not colon.git commit -m "Add <your-name> to Contributors list"
the above command is from zh-tw, which has an extra angle brackets (<>
) aroundyour-name
(and is the same in the next line of text).replacing `your-name` with your name.
In zh-tw the period at the end of sentence is missing.
- In the Push changes to GitHub section, missing punctuation, git commands not aligned, missing collapsible section:
Push your changes using the command `git push`:
the above text is from En, in zh-tw colon at the end of sentence is missing.git push -u origin your-branch-name
the above command is from En, the following is from zh-tw.git push origin <add-your-name>
The command in zh-tw is missing the-u
flag, the placeholder is different and has an extra angle brackets (<>
) aroundadd-your-name
(which is the same in the next line of text).If you get any errors while pushing, click here:
in zh-tw, the wording is a bit strange, the colon at the end of sentence is missing, and in collapsible section,Also, you might want to run 'git remote -v' to check your remote address.
this line and all lines following it is missing.
- In the Submit your changes for review section:
If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.
The above text is from En, the following is zh-tw translated back to English.Go to the GitHub repository you forked previously. You will see a `Compare & pull request` button. Click it.
In zh-twGo to the GitHub repository you forked previously
is ambiguous. Tt is not clear which repository to go to (the one forked from or the forked one, thinking in Chinese ofcourse).
- In the Where to go from here? section, order of each line of text is not aligned, text style formatting and line break formatting is not aligned:
- The order of each line of text in zh-tw is not aligned with En.
Congrats! You just completed the standard fork -> clone -> edit -> pull request workflow that you'll often encounter as a contributor!
Thefork -> clone -> edit -> pull request
part of this line is italic in En but not in zh-tw.Celebrate your contribution and share it with your friends and followers by going to web app.
The above text is from En, the following is zh-tw translated back to English.Celebrate your achievements on this site and share them with friends and followers.
What is celebrated is wrong in zh-tw, should becontribution
notachievements
.- The line break formatting of
Now let's get you started with contributing to other projects. We've compiled a list of projects with easy issues you can get started on. Check out the list of projects in the web app.
is not aligned between En and zh-tw.
- The additional angle brackets (
<>
) around part of git command is consistent through out zh-tw but not aligned with En. I've make it all aligned with En, which is no angle brackets, but we can discuss whether to maintain the use of additional angle brackets (<>
) around part of git command to emphasize it.
Minor Differences
Minor differences which does not affect readability and semantics aren't listed, but this issue can be a great starting point for discussion.
For example, In the Make necessary changes and commit those changes section, the wording of En is as follows If you go to the project directory and execute the command ...
, but the wording (translated back to English) of zh-tw is as follows Execute `git status` in Command Window ...
. In zh-tw, project directory
part is missing.
And in the next paragraph, Add those changes to the branch you just created using the `git add` command:
the above text is from En, the following is zh-tw translated back to English. Then, the `git add` command can be used to add the modified items to the branch, like the following command.
In zh-tw, the branch you just created
is not specified, just branch
. I'm not sure if the difference between the two makes one easier to understand, as I already know how to navigate it, it’s hard for me to recognize where others might be having difficulty.
Also in Submit your changes for review, Soon I'll be merging all your changes into the main branch of this project. You will get a notification email once the changes have been merged.
The above text is from En, the following is zh-tw translated back to English. Soon after, if there is no conflict between your changes and the original files, we will merge all the changes into the project's master branch. You will receive a notification email after the changes are merged.
The semantics in zh-tw is a bit strange, probably because the we will merge all the changes into the project's master branch
part, it's not clear whose changes is being merged at first glance (while thinking in Chinese), but can understand after reading it several times.