# AGENTS.md

Algorithms and Data Structures implemented in JavaScript for beginners, following best practices.

## Setup

```
npm ci
```

## Commands

```
npm run test          # run the test suite, must pass before any commit
npm run test-watch
npm run style
npm run check-style
npm run prepare
```

## Layout

- `Maths/`               192 source files
- `String/`              79 source files
- `Sorts/`               65 source files
- `Dynamic-Programming/` 59 source files
- `Conversions/`         58 source files
- `Data-Structures/`     53 source files

## Conventions

- Tests live alongside the code they cover, following `Backtracking/tests/AllCombinationsOfSizeK.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.