docs: add missing agent configs (.windsurfrules, .clinerules, .aider.conf.yml)
Matches voice agent repo — now all 8 agentic tool configs present.
This commit is contained in:
parent
86a56339ab
commit
e310bd67ae
19
.aider.conf.yml
Normal file
19
.aider.conf.yml
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# .aider.conf.yml — Aider Configuration for @bytelyst Common Platform
|
||||||
|
# Helps Aider understand the project structure and conventions.
|
||||||
|
|
||||||
|
# Tell Aider to read these files for context
|
||||||
|
read:
|
||||||
|
- AGENTS.md
|
||||||
|
- README.md
|
||||||
|
|
||||||
|
# Convention file
|
||||||
|
conventions: AGENTS.md
|
||||||
|
|
||||||
|
# Lint commands
|
||||||
|
lint-cmd:
|
||||||
|
- "pnpm build 2>&1 | tail -10"
|
||||||
|
- "pnpm test 2>&1 | tail -10"
|
||||||
|
- "pnpm typecheck 2>&1 | tail -10"
|
||||||
|
|
||||||
|
# Auto-commit settings
|
||||||
|
auto-commits: false
|
||||||
23
.clinerules
Normal file
23
.clinerules
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
# .clinerules — Cline / Roo Code Rules for @bytelyst Common Platform
|
||||||
|
# Read AGENTS.md for the complete onboarding guide.
|
||||||
|
|
||||||
|
## Project: Shared packages + microservices for ByteLyst ecosystem
|
||||||
|
Architecture: pnpm monorepo with @bytelyst/* packages + @lysnrai/* Fastify services
|
||||||
|
|
||||||
|
## Mandatory Rules
|
||||||
|
1. Every Cosmos document MUST include a `productId` field
|
||||||
|
2. Every endpoint MUST validate input with Zod schemas
|
||||||
|
3. Every service MUST propagate `x-request-id` headers
|
||||||
|
4. Use `PRODUCT_ID` from `@bytelyst/config` — never hardcode `"lysnrai"`
|
||||||
|
5. Services re-export `@bytelyst/*` in `src/lib/` files
|
||||||
|
6. Use `req.log` / `app.log` — never `console.log`
|
||||||
|
7. ESM only: `"type": "module"`, `.js` extensions in imports
|
||||||
|
8. Package manager: `pnpm` — never `npm`
|
||||||
|
9. Commits: `type(scope): description`
|
||||||
|
10. After changes, verify: `pnpm build && pnpm test`
|
||||||
|
|
||||||
|
## Key File Locations
|
||||||
|
- Packages: `packages/` (@bytelyst/errors, cosmos, config, auth, api-client, react-auth, design-tokens)
|
||||||
|
- Services: `services/` (platform-service, billing-service, growth-service, tracker-service)
|
||||||
|
- Base config: `tsconfig.base.json`
|
||||||
|
- Full guide: `AGENTS.md`
|
||||||
32
.windsurfrules
Normal file
32
.windsurfrules
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
# Common Platform — Windsurf / Codeium Rules
|
||||||
|
# Read AGENTS.md for full context. These are the critical rules.
|
||||||
|
|
||||||
|
Project: @bytelyst/* shared packages + @lysnrai/* microservices
|
||||||
|
Stack: TypeScript, ESM, pnpm workspace, Fastify 5, Vitest, Azure Cosmos DB
|
||||||
|
|
||||||
|
## Architecture Rules
|
||||||
|
- @bytelyst/* = shared packages (packages/), @lysnrai/* = product services (services/)
|
||||||
|
- Product-agnostic: every Cosmos document MUST include productId field
|
||||||
|
- Services re-export @bytelyst/* in src/lib/ files for clean internal imports
|
||||||
|
- Services use self-contained Zod config schemas (not from shared packages)
|
||||||
|
- Package manager: pnpm — NEVER use npm
|
||||||
|
|
||||||
|
## Key Paths
|
||||||
|
- Packages: packages/ (@bytelyst/errors, cosmos, config, auth, api-client, react-auth, design-tokens)
|
||||||
|
- Services: services/ (platform 4003, billing 4002, growth 4001, tracker 4004)
|
||||||
|
- Base TS config: tsconfig.base.json (ES2022, NodeNext, strict)
|
||||||
|
- Workspace: pnpm-workspace.yaml
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
- ESM everywhere ("type": "module", .js extensions in imports)
|
||||||
|
- Fastify module pattern: types.ts → repository.ts → routes.ts
|
||||||
|
- Heavy deps in peerDependencies, workspace deps as "workspace:*"
|
||||||
|
- Use req.log / app.log — never console.log
|
||||||
|
- Commits: feat(scope): description / fix(scope): description
|
||||||
|
|
||||||
|
## Consumers
|
||||||
|
- Dashboards in ../learning_voice_ai_agent/ consume packages via file: refs
|
||||||
|
- Prerequisite: pnpm build before consumer npm install
|
||||||
|
|
||||||
|
## Build Verification
|
||||||
|
- pnpm build && pnpm test && pnpm typecheck
|
||||||
Loading…
Reference in New Issue
Block a user