Skip to content

Commit fdca592

Browse files
committed
docs: enhance Copilot instructions for clarity and organization
1 parent 1047b60 commit fdca592

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

.github/copilot-instructions.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,38 @@
1+
# Copilot Instructions
2+
3+
## Package Management
4+
15
This project uses pnpm for package management.
26

3-
The project code is in the app/ directory, so make sure to run commands like installation and tests from within that directory.
7+
## Testing
48

59
When improving unit test coverage, run only the unit tests since running e2e tests may be unnecessary.
610

11+
## Svelte 5
12+
713
This project uses Svelte 5. Use the Svelte 5 runes syntax instead of the older `$:` syntax.
814

15+
16+
## Semantic Classes
17+
918
Always add semantic classes or IDs to important DOM elements, so our unit test and user interface can be self-documenting.
1019

20+
21+
## Imports
22+
1123
Prefer absolute imports like `$lib/types` instead of relative imports. Don't mix absolute and relative imports. Relative imports in the same directory are alright.
1224

25+
26+
## UI Components
27+
1328
We use Tailwind CSS for styles and daisyUI for semantic components. Where possible, prefer daisyUI components for clean template code.
1429

30+
## Project Structure
31+
1532
Business logic should reside mainly in the lib folder (service layer) so our templates can be very thin.
33+
34+
## Working directory
35+
36+
The project code is in the app/ directory. All commands should be run from this directory.
37+
38+
Console commands will automaticlly be run in the app/ directory, so you don't need to prefix them with `pnpm --filter @workouts/app` or `cd app/`. Just run them as is.

0 commit comments

Comments
 (0)