Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 1.13 KB
Raw

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.

If you are simply looking to start working with the codebase, navigate to the GitHub "issues" tab and start looking through interesting issues. There are a number of issues listed under Docs and good first issue where you could start out.

Feel free to ask questions on the mailing list or on Slack.

As contributors and maintainers to this project, you are expected to abide by TransitionZero's code of conduct. More information can be found in the Code of Conduct.

Installing dev dependencies

git clone https://github.com/transition-zero/tz-client.git
cd tz-client
pip install ".[dev]"

To install pre-commit hooks (recommended), run

pre-commit install

Please also run mypy with

pip install ".[dev]" && mypy -p tz.client

Authentication

Running our test suite first requires authentication

tz auth login

Running tests

pytest

After having made changes in the codebase, run pip install ".[dev]" to pick them up in the tests.