# 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](https://docs.trajectonomics.com/contribute/tax/).

## Set up

Clone the repository and install its dependencies with Bun. Use Bun only; the repository has no npm,
pnpm or yarn lockfile.

```bash
git clone https://github.com/trajectonomics/trajectonomics.git
cd trajectonomics
bun install
```

## Check a change

Run every package's checks from the root:

```bash
bun run check
```

To check one package, run Turborepo with a filter, for example:

```bash
bunx turbo run check --filter=@trajectonomics/tax
```

## Send a change

- Never commit to `main`. Work on a branch named `feat/...`, `fix/...` or `docs/...`, and open a pull
  request into `main`.
- Give the pull request a conventional-commit title with the package's scope, such as `feat(tax): ...`,
  `fix(docs): ...` or `docs: ...`.
- Read the repository's [CONTRIBUTING.md on GitHub](https://github.com/trajectonomics/trajectonomics/blob/main/CONTRIBUTING.md)
  for the full set of rules.

Part of the [Docs index](https://docs.trajectonomics.com/llms.txt).
