From add2429606aa8136b00cd3ed765848bff99f0222 Mon Sep 17 00:00:00 2001 From: Jesse Wierzbinski Date: Sun, 6 Jul 2025 05:06:05 +0200 Subject: [PATCH] docs: :memo: Improve Copilot instructions file --- .github/copilot-instructions.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 183c499e..5638c288 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -13,4 +13,10 @@ const add = (a: number, b: number): number => a + b; We always write TypeScript with double quotes and four spaces for indentation, so when your responses include TypeScript code, please follow those conventions. -Our codebase uses Drizzle as an ORM, with custom abstractions in `classes/database/` for interacting with the database. The `@versia-server/kit/db` and `@versia-server/kit/tables` packages are aliases for these abstractions. +Our codebase uses Drizzle as an ORM, which is exposed in the `@versia-server/kit/db` and `@versia-server/kit/tables` packages. This project uses a monorepo structure with Bun as the package manager. + +The app has two modes: worker and API. The worker mode is used for background tasks, while the API mode serves HTTP requests. The entry point for the worker is `worker.ts`, and for the API, it is `api.ts`. + +Run the typechecker with `bun run typecheck` to ensure that all TypeScript code is type-checked correctly. Run tests with `bun test` to ensure that all tests pass. Run the linter and formatter with `bun lint` to ensure that the code adheres to our style guidelines, and `bun lint --write` to automatically fix minor/formatting issues. + +Cover all new functionality with tests, and ensure that all tests pass before submitting your code.