# AGENTS.md

Joplin - the privacy-focused note taking app with sync capabilities for Windows, macOS, Linux, Android and iOS.

## Setup

```
yarn install
```

## Commands

```
yarn test                     # run the test suite, must pass before any commit
yarn buildApiDoc
yarn buildScriptIndexes
yarn buildParallel
yarn buildPluginDoc
yarn buildSequential
yarn buildServerDocker
yarn buildSettingJsonSchema
```

## Layout

- `packages/` 3782 source files
- `Assets/`   87 source files

## Conventions

- Tests live alongside the code they cover, following `packages/app-cli/app/cli-integration-tests.test.ts`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- CI defines what passing means. See `.github/workflows/automerge.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `.yarn/releases/yarn-4.16.0.cjs` is 2943KB. 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.