Get started
How to set up the Trajectonomics repository, run its checks and send a change.
Trajectonomics is one repository. The docs, the CLI, the core packages and the brand assets all live in it. Most outside contributions are tax rules, so start with the tax contributor guide.
Set up
Clone the repository and install its dependencies with Bun. Use Bun only; the repository has no npm, pnpm or yarn lockfile.
git clone https://github.com/trajectonomics/trajectonomics.git
cd trajectonomics
bun install Check a change
Run every package’s checks from the root:
bun run check To check one package, run Turborepo with a filter, for example:
bunx turbo run check --filter=@trajectonomics/tax Send a change
- Never commit to
main. Work on a branch namedfeat/...,fix/...ordocs/..., and open a pull request intomain. - Give the pull request a conventional-commit title with the package’s scope, such as
feat(tax): ...,fix(docs): ...ordocs: .... - Read the repository’s CONTRIBUTING.md on GitHub for the full set of rules.