From de813d5b4a51278a081d1693411d13c8defa9517 Mon Sep 17 00:00:00 2001 From: kenneth Date: Sat, 17 Jan 2026 11:48:20 +0000 Subject: [PATCH] docs: add AGENTS.md Co-authored-by: Ona --- AGENTS.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..8b61c7b --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,41 @@ +# AGENTS.md + +## Project + +ARIS is an AI-powered personal assistant that aggregates data from various sources into a contextual feed. Monorepo with `packages/` (shared libraries) and `apps/` (applications). + +## Commands + +- Install: `bun install` +- Test: `bun test` (run in the specific package directory) +- Lint: `bun run lint` +- Format: `bun run format` +- Type check: `bun tsc --noEmit` + +Use Bun exclusively. Do not use npm or yarn. + +## Code Style + +- File names: kebab-case (`data-source.ts`) +- Prefer function declarations over arrow functions +- Never use `any` - use `unknown` and narrow types +- Enums: use const objects with corresponding types: + ```typescript + const Priority = { + Low: "Low", + High: "High", + } as const + type Priority = (typeof Priority)[keyof typeof Priority] + ``` +- File organization: types first, then primary functions, then helpers + +## Before Committing + +1. Format: `bun run format` +2. Test the modified package: `cd packages/ && bun test` +3. Fix all type errors related to your changes + +## Git + +- Branch: `feat/`, `fix/`, `ci/`, etc. +- Commits: conventional commit format, title <= 50 chars