Contributing
- Fork the repository.
- Create a topic branch.
- Install the necessary dependencies with
pipenv install
. If you don’t have pipenv, find installation instructions here.
- Implement your feature or bug fix.
- Don’t forget to add tests and make sure they pass.
- Make sure your code complies with the style guide by running
pipenv run pylint lokalise/
. pipenv run autopep8 -i -r lokalise/ -a
can automatically fix many issues for you.
- We use type hinting so check if everything is okay by running
pipenv run mypy lokalise/`
.
- If necessary, add documentation for your feature or bug fix.
- Commit and push your changes.
- Submit a pull request.
Running tests
- Copypaste
.env.example
file as .env
.
- Put your API token inside. The
.env
file is excluded from version control so your token is safe. All in all, we use pre-recorded VCR cassettes, so the actual API requests won’t be sent.
- Run
pipenv run pytest
. Observe test results and coverage. All your tests will be linted automatically.