Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

66 lines (45 loc) · 2.93 KB
Raw

Web3Auth L10n - Localization Contributions

Thank you for your interest in contributing to the localization efforts of our projects! This guide will help you get started with contributing to the localization files.

Getting Started

  1. Fork the repository to your own GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your localization changes.
  4. Follow the guidelines mentioned below to make the necessary changes to the localization files.

Contributing Guidelines

1. Branching

  • Create a new branch for each localization language or update you're working on.
  • Name the branch descriptively, such as feature/localization-spanish or fix/localization-french.
  • Base your branch on the latest main branch.

2. Localization Files

  • All localization files of different projects are located in separate directories.
  • Use the existing localization files as a reference for adding or updating translations.
  • Maintain the structure and format of the existing files.
  • Use Sort JSON extension for VS Code to sort the keys in the localization files.
  • Ensure accurate translations and proper grammar.
  • Avoid using machine translations whenever possible. Human translation is preferred.
  • Do not change the keys or identifiers used in the localization files.

3. Translation Process

  • Locate the relevant localization file for the language you're contributing to.
  • Make the necessary changes to the translations, keeping in mind the guidelines mentioned above.
  • Commit your changes with a descriptive message.
  • Push your changes to your forked repository.
  • Create a pull request to the main branch of the original repository.

3.1 Pull Request

  1. Go to the original repository on GitHub.
  2. Switch to the branch you created earlier.
  3. Click on "New Pull Request" and fill out the details:
  • Base branch: main
  • Head branch: your-username:branch-name
  1. Include a clear and concise description of the changes made.
  2. Submit the pull request.

4. Review Process

  • The localization files will be reviewed by the maintainers of the repository.
  • The maintainers may request changes to the localization files.
  • Once the localization files are approved, they will be merged into the main branch.

Code of Conduct

Please note that we have a Code of Conduct in place to ensure a welcoming and inclusive environment for all contributors. Make sure to familiarize yourself with the guidelines outlined in the CODE_OF_CONDUCT.md file.

License

By contributing to the localization files, you agree that your contributions will be licensed under its MIT License.

Contact

If you have any questions or need assistance, feel free to reach out to us via [email protected] or open an issue in the repository.

Thank you for your valuable contributions to Web3Auth L10n!