Setup Guide
1. Automated dependency installation
Installing all the dependencies
make deps
2. Build
To build and rebuild after changes to Rust files
Note: Make sure you have rust compiler installed. This package requires Rust and Cargo to compile extensions.
make install
3. Test
Tach internally uses pytest
module for testing all the files within python/tests/
make test
4. Setting up the docs
Tach internally uses mintlify
platform to create and maintain public facing documentation
Note: contributors would need to install Node and npm
make docs
8. Things to check before committing
Check and sync your dependencies in the root folder
tach check
tach sync
Type checking
make type-check
Run linting checks for Rust and Python code
make lint
Format Rust and Python code
make fmt
That’s it! You are now ready to push your new dev branch to your forked repo and then raise a PR with appropriate description
Find Beginner Friendly issues here:
For any questions, just drop a message in Discord