mirror of https://github.com/kennethnym/aris.git synced 2026-02-02 13:11:17 +00:00

Files

docs: add GPG signing instruction to AGENTS.md

Co-authored-by: Ona <no-reply@ona.com>

2026-01-18 20:39:26 +00:00

1.2 KiB

Raw Blame History

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:

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

Format: bun run format
Test the modified package: cd packages/<package> && bun test
Fix all type errors related to your changes

Git

Branch: feat/<task>, fix/<task>, ci/<task>, etc.
Commits: conventional commit format, title <= 50 chars
Signing: If GPG_PRIVATE_KEY_PASSPHRASE env var is available, use it to sign commits with git commit -S

1.2 KiB Raw Blame History