vrr/airi
2
0
Fork 0
mirror of https://github.com/moeru-ai/airi.git synced 2026-04-26 13:40:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

chore(AGENTS.md): updated

Browse source
This commit is contained in:
Neko Ayaka 2026-04-24 03:24:27 +08:00
parent 47074021c0
commit a7941f27dd
No known key found for this signature in database
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
AGENTS.md
View file

@ -206,10 +206,12 @@ These guidelines apply to all TypeScript code across the monorepo:
- For functions that include workarounds, include a `NOTICE:` explanation.
- For `describe`, `it`, and all `expect*` usage in tests, include examples by using `@example`.
- For all exported interfaces, especially configurable options, document:
- What each interface/option does.
- When to use it.
- The use cases it is intended for.
- What each interface/type represents.
- Put detailed field semantics on the fields themselves instead of repeating them in one large interface-level comment block.
- If the interface or type uses generic parameters, document them with `@param`.
- `@default` for every option that has a default value.
- For interface and type JSDoc, keep the top-level comment focused on what the type represents. Do not use function-style `Use when`, `Expects`, or `Returns` sections on interfaces or type aliases. Put detailed meaning, defaults, and behavioral notes on the individual fields or methods instead of restating every field in the interface-level block.
- For generic type parameters in JSDoc, use `@param` entries to explain what each type parameter represents.
- For all runner, CLI, and high-level orchestrator code (exported or not), `/** ... */` JSDoc is required and must include a clear ASCII call-stack diagram using `{@link ...}` references where applicable.
- Use this call-stack section format in orchestrator/runner/CLI JSDoc:
```ts