DenverCoder1 / DenverCoder1/github-readme-youtube-cards
🗪 Add Translations to YouTube Cards
- Dominant language
- Python
- Stars
- 282
- Forks
- 65
- Avg merge
- 5d 9h
- Merged PRs (30d)
- 2
Description
If you know a language not yet supported by GitHub Readme YouTube Cards, you can help by opening a PR!
All it takes to contribute is to translate [two words](https://github.com/DenverCoder1/github-readme-youtube-cards/blob/main/api/locale/en.yml).
See a list of currently supported locales at [`/api/locale/`](https://github.com/DenverCoder1/github-readme-youtube-cards/tree/main/api/locale).
It is important that the translations are accurate and sound natural. There is also a preference to matching the translations shown on the YouTube website if possible.
The locale code added to the file should be a 2-letter abbreviation from [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) or a 4-letter code with a language and country code (eg. `ja` or `pt_BR`). Anything appearing in [this list](https://gist.github.com/DenverCoder1/74712a0540932d01fda3b347222292f9) should be fine.
## Adding a locale
### Option 1: Running locally
You may refer to [`CONTRIBUTING.md`](https://github.com/DenverCoder1/github-readme-youtube-cards/blob/main/CONTRIBUTING.md) for details on installing dependencies and running the project locally.
1. Fork the repository and clone your fork to your computer
2. Create a new branch (you can name it with the name of your locale)
3. Copy the contents of `api/locale/en.yml` file to `api/locale/.yml`, where IDENTIFIER is [shorthand](https://gist.github.com/DenverCoder1/74712a0540932d01fda3b347222292f9) for the language you are adding, for example, French would be `fr.yml`.
4. Change the top most yaml key `en:` to your language's identifier and add translations for the strings provided in the file. Only alter the text enclosed in quotes.
5. [Optional] Run the project and add `&lang=IDENTIFIER` to a card URL to make sure it displays correctly (e.g. `http://127.0.0.1:8000/?id=dQw4w9WgXcQ&title=Never+Gonna+Give+You+Up×tamp=1642108413&lang=fr`)
6. Commit and push your changes to your fork
7. Open a pull request for merging your branch into this repo's main branch, including a screenshot would be appreciated
### Option 2: Using the GitHub website
1. Open [`/api/locale/`](https://github.com/DenverCoder1/github-readme-youtube-cards/tree/main/api/locale) and click the "Add file" dropdown button and select "Create new file"

2. Copy the contents of [`api/locale/en.yml`](https://github.com/DenverCoder1/github-readme-youtube-cards/blob/main/api/locale/en.yml).

3. Paste the contents of `en.yml` into the editor and add your locale's [identifier](https://gist.github.com/DenverCoder1/74712a0540932d01fda3b347222292f9) as the filename followed by the `.yml` extension, for example, French would be `fr.yml`. Change the top most yaml key `en:` to your language's identifier and add translations for the strings provided in the file. Only alter the text enclosed in quotes.

4. Add a message and create a new branch with your changes by clicking "Propose new file"

5. Click "Create Pull Request" to open a pull request for merging your branch into this repo's main branch
----
> **Note**
> When adding a right-to-left language, `direction: rtl` should be added to the yaml file to ensure it will display correctly. See [`he.yml`](https://github.com/DenverCoder1/github-readme-youtube-cards/blob/main/api/locale/he.yml) as an example.
Make sure to keep the spacing and formatting consistent.
You can see #70 for an example of what your pull request should look like.
Your locale will become available when your Pull Request is approved.
If you have any questions, feel free to ask!
Contributor guide
Assessment
This issue has not been assessed yet.