mirror of
https://github.com/louisleroy5/trnslator.git
synced 2024-11-14 16:20:31 -05:00
18 lines
1.4 KiB
Markdown
18 lines
1.4 KiB
Markdown
|
Thank you for using *translater* and for considering contributing to it!
|
||
|
|
|
||
|
|
#### For errors in the code:
|
||
|
|
|
||
|
|
- read the error message and [documentation](https://translater.readthedocs.io/);
|
||
|
|
- search through the [open issues](https://github.com/louisleroy5/translater/issues?q=is%3Aopen+is%3Aissue) and [closed issues](https://github.com/louisleroy5/translater/issues?q=is%3Aissue+is%3Aclosed) first;
|
||
|
|
- if the problem is with a dependency of this project, open an issue on the dependency's repo;
|
||
|
|
- if the problem is with *translater* and you can fix it simply, please submit a [PR](https://github.com/louisleroy5/translater/pulls);
|
||
|
|
- if the problem persists, please open an issue in the [issue tracker](https://github.com/louisleroy5/translater/issues) 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](https://github.com/louisleroy5/translater/issues) 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 translater's existing coding format, commenting, and docstring styles);
|
||
|
|
- [test it](https://github.com/louisleroy5/translater/tree/develop/tests);
|
||
|
|
- format your code using [black](https://black.readthedocs.io/en/stable/) and submit a [PR](https://github.com/louisleroy5/translater/pulls);
|
||
|
|
- respond to code review.
|