DenverCoder1 / github-readme-streak-stats

🔥 Stay motivated and show off your contribution streak! 🌟 Display your total contributions, current streak, and longest streak on your GitHub profile README
https://streak-stats.demolab.com
MIT License
4.83k stars 750 forks source link

🗪 Add Translations to Streak Stats #236

Open DenverCoder1 opened 2 years ago

DenverCoder1 commented 2 years ago

If you are a native speaker of a language that is not yet supported by Streak Stats, you can help by opening a PR!

See the Locales section of the Readme for a list of currently supported locales and percentages translated.

The locales are maintained in the /src/translations.php file.

The locale code added to file should be a 2-letter abbreviation from ISO 639-1 or a 4-letter code with a language and country code (eg. ja or pt_BR). Anything appearing in this list should be fine.

There is no need to update the README! It will get updated automatically by a bot.

Adding a locale

Option 1: Running locally

You may refer to 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. Edit translations.php to have your locale by adding each phrase mapped to a translation under your new locale. Try to keep the locale list in alphabetical order.
  4. [Optional] Run the project and preview the card on the demo site (e.g. https://localhost:8000/demo/) to make sure it displays correctly
  5. Commit and push your changes to your fork
  6. 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 translations.php and click the pencil above the README to fork the repo and start editing image
  2. Edit the file to have your locale by adding each phrase mapped to a translation under your new locale. Try to keep the locale list in alphabetical order.
  3. Add a message and create a new branch with your changes image
  4. Click Propose Changes to open a pull request for merging your branch into this repo's main branch

There is no need to update the README! It will get updated automatically by a bot.

Make sure to keep the spacing and formatting consistent.

Your locale will become available when your Pull Request is approved.

If you have any questions, feel free to ask!

tejas-nagchandi commented 2 years ago

Added Dutch translations #269

ooliver1 commented 2 years ago

Should date abbreviations such as Dec => dic be included for languages such as Spanish? Months are not capitalised and the spellings are different.

DenverCoder1 commented 2 years ago

Should date abbreviations such as Dec => dic be included for languages such as Spanish? Months are not capitalised and the spellings are different.

The IntlDateFormatter is used for that. Using the default settings for the date format, it will generate the date pattern using the locale specified. Same applies with number formatting.

ooliver1 commented 2 years ago

Should date abbreviations such as Dec => dic be included for languages such as Spanish? Months are not capitalised and the spellings are different.

The IntlDateFormatter is used for that. Using the default settings for the date format, it will generate the date pattern using the locale specified. Same applies with number formatting.

The demo doesn't seem to show that working though

DenverCoder1 commented 2 years ago

The demo doesn't seem to show that working though

What do you mean by that? For me, it seems to work as expected.

image

nishith-p-shetty commented 2 years ago

Added Kannada Translation #324

Halim-Shams commented 1 year ago

Added Pashto translations #396

Banovvv commented 1 year ago

Added Bulgarian Translations #398

Halim-Shams commented 1 year ago

Added Yoruba translations #407

mosamaasif commented 1 year ago

Added Urdu (Pakistan)(ur_PK) Translations #425

etsond commented 1 year ago

added Haitian Creole translation #444 Screenshot 2023-01-29 at 10 36 07 PM

annshiv commented 1 year ago

Added tamil translations https://github.com/DenverCoder1/github-readme-streak-stats/pull/445

benzlokzik commented 1 year ago

Added Armenian translations #479

streak-stats