Skip to content

Commit 85215ad

Browse files
authored
chore(AI): AGENTS.md (#1409)
1 parent 5e3e343 commit 85215ad

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Commands
2+
Most of the commands necessart to work in this repo are in the `./justfile` file, you can run each command like this `just <command-name>`.
3+
4+
Examples:
5+
- Run tests: `just tc`
6+
- Run doc tests: `just d`
7+
- Run torin tests: `just t-layout`.
8+
9+
## Architecture
10+
All the rust crates are located in the `./crates` folder, all those starting with freya- are related to Freya, the others are used by Freya as well but are generic, for example Torin.
11+
Rust examples are located in the `./examples` folder.
12+
The `./website` folder contains the Astro website.
13+
14+
## Rust
15+
- Avoid uwnrap() in library / examples code unless it is completely necessary, prefer to handle errors explicitely. Its fine in tests though.
16+
- Don't use `super::` for imports, prefer `crate::`
17+
- Dont put unnecessary comments, if you are adding/refactoring a feature prefer to write doc comments `///` with a proper but not big explanation.

0 commit comments

Comments
 (0)