trnslator/CONTRIBUTING.md
2020-11-02 10:43:07 -05:00

1.4 KiB

Thank you for using trnslator and for considering contributing to it!

For errors in the code:

  • read the error message and documentation;
  • search through the open issues and closed issues first;
  • if the problem is with a dependency of this project, open an issue on the dependency's repo;
  • if the problem is with trnslator and you can fix it simply, please submit a PR;
  • if the problem persists, please open an issue in the issue tracker including a minimal working example to reproduce the problem.

If you have a feature proposal or want to contribute

  • post your proposal on the issue tracker so we can review it together (some proposals may not be a good fit for the project);
  • fork the repo, make your change (adhering to trnslator's existing coding format, commenting, and docstring styles);
  • test it;
  • format your code using black and submit a PR;
  • respond to code review.