Skip to content

Latest commit

 

History

History
81 lines (48 loc) · 5.8 KB

CONTRIBUTING.md

File metadata and controls

81 lines (48 loc) · 5.8 KB

Welcome to the i18n Translation Generator contributing guide

Thank you for investing your time in contributing to our project!.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README file. Here are some resources to help you get started with open source contributions:

Getting started

There are a lot of things that you could do to collaborate on open sources projects!. Will leave you some ideas about what could you do to help us to improve i18n translation generator.

Issues

Create a new issue

If you spot any problem while using the project, see any error on the doc, or just wants to suggest changes to improve the project you can create a new issue. Please make sure of check first that the issue doesn't exists already exists on the issues list.

Solve an issue

Scan through our existing issues to find one that interests you. If you find an issue to work on, you can leave a comment on the issue to leave us know that you're working on it and when you had developed your solution you can open a PR with a fix.

Help to solve the community doubts

If there is any doubt on any issue and you think you can help to solve it, then feel free to help to clear the doubts through the comments box of the issue selected, always following our CODE OF CONDUCTS.

Making changes

Cloning repository and writing code

  1. Fork the repository.
  2. Clone the repository forked.
  3. Install or update to Node.js, at the version specified in .npmrc file.
  4. Create a working branch and start working on your changes.
  5. Make sure adding tests to your new changes and self-review your code to speed up review process.

Committing your changes

Commit the changes once you're happy with them. Please make sure you're adding a clear title to your commit.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Add a clear description and title about your changes to your PR information, so reviewers can understand easily the context of your code and code review process is speed up 🚀.
  • Don't forget to link PR to issue if you are solving one.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The i18n translation generator team thanks you ✨.

Suggestion of actions that you can take to help us to improve the project

This is a list of ideas that which you can check if you wants collaborate on the project but still doesn't know what could you do:

  1. Integrate a new translation API
  • As the most of translation API requires API Key, there are a lot of services that I could not integrate on this project, the most of projects have limited countries where their services works, for example, and I will not be able to integrate the most of them. Translation APIs as DeepL for example, or another one that you uses and is not here, feel free of integrate it on the code so you and other users that already are clients of those translation services would be able to use it also, everything thanks to you. So if there is any translation service that you're using, it have API, and you have an API key that you can use for development, you can help us to integrate it to the project.
  1. Improve the documentation
  • Documentation is a exhaustive work, create readable and clear documentations for all the project is not an easy task, and of course, will help to know the point of view of other people. That is why if you see that there is something that could be improved on the doc, you could suggest it as a PR or as an issue and it will help us a lot.
  1. Collaborate on side projects related to the project
  • We are currently working on some projects related to i18n translation generator in order to improve the way you create i18n translations the most possible. Projects in mind are:
    1. Landing Page to explain easily the idea to developers.
    2. Documentation Page in order to improve the doc of the project and make more easier the use of it.
    3. Visual Studio Code Extension in order to create a user interface for users that doesn't feel comfortable with CLI Commands.

Feel free to collaborate on any of them! We would appreciate any help!