git/metabuilder
1
0
Fork 0
mirror of https://github.com/johndoe6345789/metabuilder.git synced 2026-04-24 13:54:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: prompts,kickstart,github (1 files)

Browse Source
This commit is contained in:
JohnDoe6345789
2025-12-25 20:03:24 +00:00
parent 85ba7909e9
commit b765cc0eaf
1 changed files with 26 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
.github/prompts/0-kickstart.md vendored
View File

@@ -14,10 +14,33 @@ Use this as the default workflow when starting work in this repo.
- Maintain: `7-maintain-*.prompt.md`
- Docs: `8-docs-feature.prompt.md`
3. Keep changes small and follow existing patterns; avoid dependency churn.
4. Check for scoped rules in nested `AGENTS.md` files (e.g. `dbal/AGENTS.md`) before editing those areas.
## Where Work Lives
- Next.js app: `frontends/nextjs/` (source in `src/`, E2E in `e2e/`, local scripts in `scripts/`).
- Component packages: `packages/` (seed JSON under `packages/*/seed/`, schema checks in `packages/*/tests/`).
- DBAL: `dbal/` (TypeScript library in `dbal/ts/`).
- Prisma schema/migrations: `prisma/` (`schema.prisma`, `migrations/`).
- Shared config: `config/` (symlinked into `frontends/nextjs/`).
## Common Commands
Run app workflows from `frontends/nextjs/`:
- Install: `npm ci` (or `npm install`)
- Dev: `npm run dev`
- Build/serve: `npm run build` / `npm run start`
- Lint: `npm run lint` / `npm run lint:fix`
- Typecheck: `npm run typecheck`
- Unit: `npm run test:unit` / `npm run test:coverage`
- E2E: `npm run test:e2e`
- Prisma: `npm run db:generate` / `npm run db:push` / `npm run db:migrate`
DBAL workflows live in `dbal/ts/` (`npm run build`, `npm run test:unit`).
## Source + Tests
- TypeScript + ESM. Prefer `@/…` imports inside `frontends/nextjs/src/`.
- React components: `PascalCase.tsx`; hooks: `useThing.ts`; tests: `*.test.ts(x)`.
- Prefer one focused function (“lambda”) per file; use classes only as containers for related functions (see `.github/prompts/LAMBDA_PROMPT.md`).
- Keep tests parameterized where it improves coverage (`it.each()`), and keep source↔test naming aligned.
- Keep tests deterministic (no network, stable clocks/IDs), and parameterize where it improves coverage (`it.each()`); keep source↔test naming aligned.
- Leave TODOs only when you’re explicitly deferring follow-up work.
## Git Hygiene
@@ -26,7 +49,8 @@ Use this as the default workflow when starting work in this repo.
## Architecture Guardrails
- Route data access through DBAL / the `Database` wrapper; don’t bypass it.
- UI uses Material UI (`@mui/*`); don’t introduce Radix UI or Tailwind. See `docs/RADIX_TO_MUI_MIGRATION.md` and `UI_STANDARDS.md`.
- UI uses Material UI (`@mui/*`) and SCSS/modules as needed; don’t introduce Radix UI or Tailwind. See `docs/RADIX_TO_MUI_MIGRATION.md` and `UI_STANDARDS.md`.
- Package metadata: keep `packages/*/seed/metadata.json` `packageId` in `snake_case` and versions semver (e.g. `1.2.3`).
## CI / Workflows
- Use `act` to reproduce and debug GitHub Actions locally (see `npm run act`, `npm run act:diagnose`).