39 lines
1.5 KiB
Markdown
39 lines
1.5 KiB
Markdown
# GitHub Copilot Instructions — NoteLett
|
|
|
|
> For full agent instructions, read [`AGENTS.md`](../AGENTS.md) at the repo root.
|
|
|
|
## Project Context
|
|
|
|
**NoteLett** — structured notes platform for humans and AI agents.
|
|
Stack: Fastify 5 + TypeScript ESM backend, Next.js web, Expo mobile, and @bytelyst/* shared packages
|
|
|
|
## Code Generation Rules
|
|
|
|
### Always
|
|
- Backend follows the ByteLyst product-backend pattern with Fastify 5 + TypeScript ESM
|
|
- Use @bytelyst/* shared packages instead of reimplementing common infrastructure
|
|
- Fastify modules follow types.ts → repository.ts → routes.ts
|
|
- Use req.log / app.log — never console.log
|
|
- Every Cosmos document MUST include productId: "notelett"
|
|
- Keep docs aligned with implementation as the repo evolves from scaffold to product
|
|
- Include `productId: "notelett"` in every Cosmos DB document
|
|
- Use `type(scope): description` commit message format
|
|
- Fix source code, not tests (unless the test itself is wrong)
|
|
|
|
### Never
|
|
- `console.log` or `print()` in production code
|
|
- Hardcoded secrets, API keys, colors, or URLs
|
|
- Delete existing comments or documentation unless explicitly asked
|
|
- Add emojis unless asked
|
|
|
|
## Key Paths
|
|
- docs/ — PRD, roadmap, and planning docs
|
|
- backend/ — Fastify 5 + TypeScript ESM backend (port 4016)
|
|
- backend/src/modules/ — notes, workspaces, relationships, tasks, artifacts, reviews, prompts, intake, palace, and sharing
|
|
- backend/src/lib/ — shared backend wiring and utilities
|
|
|
|
## Build Verification
|
|
```bash
|
|
pnpm run verify
|
|
```
|