# AGENTS.md

📝 Algorithms and data structures implemented in JavaScript with explanations and links to further readings

## Setup

```
npm ci
```

## Commands

```
npm run test       # run the test suite, must pass before any commit
npm run lint       # lint
npm run coverage
npm run ci
npm run prepare
```

## Layout

- `src/` 360 source files

## Conventions

- Tests live alongside the code they cover, following `src/algorithms/cryptography/caesar-cipher/__test__/caesarCipher.test.js`.
- CI defines what passing means. See `.github/workflows/CI.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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.