From 066220ffbda277ae7f472b7024170bd9166c1633 Mon Sep 17 00:00:00 2001 From: Jesse Wierzbinski Date: Tue, 25 Feb 2025 23:18:39 +0100 Subject: [PATCH] feat: :sparkles: Add Copilot Instructions file --- .github/copilot-instructions.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .github/copilot-instructions.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 00000000..d312a696 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,16 @@ +We use full TypeScript and ESM with Bun for our codebase. Please include relevant and detailed JSDoc comments for all functions and classes. Use explicit type annotations for all variables and function return values, such as: + +```typescript +/** + * Adds two numbers together. + * + * @param {number} a + * @param {number} b + * @returns {number} + */ +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/kit/db` and `@versia/kit/tables` packages are aliases for these abstractions.