Skip to content

Commit fcb7c1d

Browse files
committed
Add section on Aristo to CONTRIBUTING.md
1 parent 72e8778 commit fcb7c1d

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,19 @@ And launch an Antithesis test run with:
413413
scripts/antithesis/launch.sh
414414
```
415415

416+
## Annotating intent with Aristo
417+
418+
Turso uses [Aristo](https://github.com/aretta-ai/aristo) to capture design intent that the code alone doesn't spell out — invariants a refactor could silently break — as `#[aristo::intent("...")]` annotations attached to the code. They're optional; reach for one only when a property is invisible from the signature and not already guarded by a test.
419+
420+
The macros are a workspace dependency, so annotated code builds normally. To author and lint annotations, install the CLI:
421+
422+
```console
423+
cargo install aristo-cli # provides the `aristo` command
424+
aristo lint # lint annotation prose (also runs in CI on every PR)
425+
```
426+
427+
To machine-check annotations, run `/aristo-neural-verify` in Claude Code.
428+
416429
## Adding Third Party Dependencies
417430

418431
When you want to add third party dependencies, please follow these steps:

0 commit comments

Comments
 (0)