|
1 | 1 | # copilot-instructions.md |
2 | 2 |
|
3 | | -## Architecture & Project Structure |
| 3 | +### Architecture & Project Structure |
4 | 4 |
|
5 | 5 | - **Client Projects**: Multiple platform-specific clients sharing core infrastructure |
6 | 6 | - `Client.Core`: Blazor pages, shared components, service, typescript and SCSS files. |
|
16 | 16 |
|
17 | 17 | - **Boilerplate.Tests**: Integration api and UI tests using Playwright and MSTest. |
18 | 18 |
|
19 | | -## Technology Stack |
20 | | - |
21 | 19 | ### Technologies |
22 | 20 | - **C# 13.0** |
23 | 21 | - **ASP.NET Core 9.0** |
|
33 | 31 | - **TypeScript**: Type-safe JavaScript development |
34 | 32 | - **SCSS**: Advanced CSS preprocessing |
35 | 33 |
|
36 | | -## Development Guidelines |
37 | | - |
38 | 34 | ### Code Style & Conventions |
39 | 35 | - **C# 13.0**: Use latest language features |
40 | 36 | - **Nullable Reference Types**: Enabled project-wide |
@@ -68,12 +64,25 @@ dotnet test |
68 | 64 | ### GitHub Codespaces Support |
69 | 65 | The project is optimized for GitHub Codespaces development with pre-configured container support. |
70 | 66 |
|
71 | | -## Best Practices |
| 67 | +### Best Practices |
72 | 68 |
|
73 | 69 | 1. **Follow the established project structure** |
74 | 70 | 2. **Use Bit.BlazorUI components** - leverage the framework's built-in components and utilities |
75 | 71 | 3. **Follow nullable reference type conventions** - all new code should be nullable-aware |
76 | 72 | 4. **Use dependency injection** - leverage the built-in DI container for service registration |
77 | 73 | 5. **Implement proper logging** - use structured logging throughout the application |
78 | 74 | 6. **Follow security best practices** - use proper authentication and authorization patterns |
79 | | -7. **Async Programming** - prefer async/await for I/O-bound operations, avoid blocking calls |
| 75 | +7. **Async Programming** - prefer async/await for I/O-bound operations, avoid blocking calls |
| 76 | + |
| 77 | +### Tool Usage: DeepWiki for BitPlatform |
| 78 | +You have a special tool, `deepwiki`, for accessing documentation about the `bitfoundation/bitplatform` library. |
| 79 | + |
| 80 | +**RULE:** If a question mentions or implies the use of a "Bit" component (like `BitButton`, `BitTooltip`, `BitTextField`), or refers to the "bitplatform" or "bit Boilerplate", |
| 81 | +you **MUST** use the `deepwiki` tool to find the correct implementation before writing any code. Do not use generic HTML/CSS/JS solutions for these components. |
| 82 | + |
| 83 | +**Command:** |
| 84 | +`deepwiki fetch bitfoundation/bitplatform` |
| 85 | + |
| 86 | +**Example Usage:** |
| 87 | +* **User Prompt:** "How do I make a BitButton disabled?" |
| 88 | +* **Your Action:** First, run `deepwiki fetch bitfoundation/bitplatform to search for How do I make a BitButton disabled?`. Then, use the documentation to answer the user. |
0 commit comments