👍🎉 To begin with, thank you for taking the time to contribute and read these guidelines! 🎉👍
We are very grateful for every bug that you manage to spot! Please open a new GitHub issue and use a template for a bug report
If you have an idea on how to make Textinator better, please suggest it via opening a feature request. Let's discuss it and maybe your feature will make it to the next release of Textinator!
If you want to help localize Textinator to a new language, please open a translation request and we'll take it from there.
Currently Textinator is mostly tested manually, so we would be very grateful for any kinds of tests: unit tests, integration tests or interaction tests. Please open a GitHub issue, assign it a testing label and describe what kind of tests you are willing to do.
We follow the "fork-and-pull" Git workflow. The approach can be summarized as follows:
- Fork the original repository to your own Github account
- Clone the project to your machine
- Create a branch locally with a descriptive name
- Commit changes to the branch
- Fix style issues reported by precommit.
- Commit again.
- Push changes to your fork
- Open a PR in the original repository and wait for a code review.