Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add korean translation of README.md #4845

Merged
merged 5 commits into from
Nov 10, 2020
Merged

Conversation

KIMMINTAE98
Copy link
Contributor

@KIMMINTAE98 KIMMINTAE98 commented Nov 9, 2020

What is it?

  • Bugfix (user facing)
  • Feature (user facing)
  • Codebase improvement (dev facing)
  • Meta improvement to the project (dev facing)

Description of the changes in your PR

  • Added README_KO.md which is korean translation of README.md
    to active the participation of the Korean contributors or download of Korean users.

Due diligence

@Stypox
Copy link
Member

Stypox commented Nov 9, 2020

Is this the standard way to provide a translated README for GitHub repositories? Will Korean users automatically see it when opening the repo?

@opusforlife2
Copy link
Collaborator

@Stypox See for example https://github.com/tiimgreen/github-cheat-sheet/blob/master/README.md which contains links to translated versions of itself.

However, it uses README.ko.md instead of README_KO.md like Min-Tae has done here.

@Stypox
Copy link
Member

Stypox commented Nov 9, 2020

@KIMMINTAE98 thank you! Can you rename the file to README.ko.md as requested by opusforlife2? Then this can be merged, can't it @B0pol @opusforlife2?

@opusforlife2
Copy link
Collaborator

@Stypox Note that I haven't found any official Github documentation on this. What I've said above is just from researching what seem to be the best practices in other repos.

@B0pol
Copy link
Member

B0pol commented Nov 10, 2020

@Stypox no, in README.md there shoul be a line like "korean translation", otherwise nobody will know about this translation.

Also, why are section titles not translated?

@opusforlife2
Copy link
Collaborator

@B0pol The Readme I linked has:

Read this in other languages: English, 한국어, 日本語, 简体中文, 正體中文.

We could add that to our Readme.

All READMEs should contains links to translated versions.
Copy link
Member

@Stypox Stypox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@B0pol B0pol merged commit 5b6e187 into TeamNewPipe:dev Nov 10, 2020
This was referenced Nov 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants