# AGENTS.md

An interactive git visualization and tutorial. Aspiring students of git can use this app to educate and challenge themselves towards mastery of git!

## Setup

```
yarn install
```

## Commands

```
yarn dev             # run locally
yarn build           # produce a build
yarn test            # run the test suite, must pass before any commit
yarn preinstall
yarn prepare
yarn test:coverage
```

## Layout

- `src/`       114 source files
- `__tests__/` 23 source files
- `scripts/`   4 source files

## Conventions

- Tests live alongside the code they cover, following `__tests__/CommandLineStore.spec.js`.
- CI defines what passing means. See `.github/workflows/build-docker.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/js/intl/strings.js` is 212KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.