Skip to content

๐ŸŒ Help Translate Our README!ย #317

Description

@syvixor

๐ŸŒ Help Translate Our README!

Hi everyone! ๐Ÿ‘‹

Our project is growing, and we want to make it more accessible to developers all over the world ๐ŸŒ by adding more translations of our documentation.

โœ… Currently supported:

  • ๐Ÿ‡ฌ๐Ÿ‡ง English
  • ๐Ÿ‡จ๐Ÿ‡ณ Chinese
  • ๐Ÿ‡ช๐Ÿ‡ธ Spanish
  • ๐Ÿ‡ช๐Ÿ‡ธ Catalan
  • ๐Ÿ‡ฎ๐Ÿ‡น Italian
  • ๐Ÿ‡ท๐Ÿ‡บ Russian
  • ๐Ÿ‡น๐Ÿ‡ท Turkish
  • ๐Ÿ‡ต๐Ÿ‡น Portuguese
  • ๐Ÿ‡ฉ๐Ÿ‡ช German
  • ๐Ÿ‡ฐ๐Ÿ‡ท Korean
  • ๐Ÿ‡ฏ๐Ÿ‡ต Japanese
  • ๐Ÿ‡ฎ๐Ÿ‡ณ Hindi
  • ๐Ÿ‡ฎ๐Ÿ‡ณ Malayalam
  • ๐Ÿ‡ฌ๐Ÿ‡ท Greek
  • ๐Ÿ‡ง๐Ÿ‡ท Brazilian Portuguese
  • ๐Ÿ‡ฒ๐Ÿ‡พ Malay
  • ๐Ÿ‡ง๐Ÿ‡ฉ Bengali

Weโ€™d love your help translating the README into other languages!

๐Ÿ“ How to Contribute

  1. Pick a Language
    Check the comments to see if someone is already working on your language.
    If not, comment below to claim it so we can avoid duplicate work.

  2. Translate the README
    Create a new folder inside the i18n/ directory named after your language code (see ISO 639-1 codes).
    Then add your translated files like this:

    i18n/<lang-code>/README.md
    

    Example:

    • i18n/it/README.md for Italian
    • i18n/es/README.md for Spanish
    • i18n/ru/README.md for Russian

    You can also translate CONTRIBUTING.md if you'd like โ€” put it in the same folder.

  3. Add Language Links
    To help users find translated versions, feel free to help us update the main README.md with a language
    switcher at the top.
    Only include links for translations that are already available.

  4. Submit a Pull Request (PR)
    Once you're done, open a PR with your changes.

๐Ÿ™Œ Thank You!

Your contribution helps make this project accessible to more people.
Whether you translate a single section or the entire README, thank you for making the open-source community more inclusive! ๐Ÿ’–

Letโ€™s make it happen! ๐Ÿš€

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions