Skip to content

Commit ff6b7c3

Browse files
authored
feat(templates): improve bit Boilerplate copilot configuration #11119 (#11120)
1 parent 00de384 commit ff6b7c3

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
# copilot-instructions.md
1+
# GitHub Copilot Instructions
2+
3+
## Key Technologies
24

3-
### Technologies
45
- **C# 13.0**
56
- **ASP.NET Core 9.0**
67
- **Blazor**: Component-based web UI framework
7-
- **.NET MAUI**: Cross-platform app development
8+
- **.NET MAUI Blazor Hybrid**: Cross-platform app development
89
- **ASP.NET Core Identity**: Authentication and authorization
910
- **Entity Framework Core**: Data access
1011
- **SignalR**: Real-time communication
@@ -15,7 +16,7 @@
1516
- **TypeScript**: Type-safe JavaScript development
1617
- **SCSS**: Advanced CSS preprocessing
1718

18-
### Best Practices
19+
## Coding Conventions & Best Practices
1920

2021
1. **Follow the established project structure**: Adhere to the defined layout for consistency.
2122
2. **Use Bit.BlazorUI Components**: Prioritize using components from the Bit.BlazorUI library over generic HTML to ensure UI consistency and leverage built-in features.
@@ -24,47 +25,46 @@
2425
5. **Implement Structured Logging**: Use structured logging for clear, queryable application logs.
2526
6. **Adhere to Security Best Practices**: Implement robust authentication and authorization patterns.
2627
7. **Use Async Programming**: Employ `async/await` for I/O-bound operations to prevent blocking threads.
27-
8. **Utilize Latest C# Features**: Write modern, concise, and efficient code by using the latest C# language features.
28-
9. **Leverage Implicit Usings**: Take advantage of global using statements.
28+
8. **Modern C#**: Write modern, concise, and efficient code by using the latest C# language features, including implicit usings and global using statements.
2929
10. **Respect .editorconfig**: Adhere to the `.editorconfig` file for consistent code style across all IDEs.
30-
12. **Prefer razor.cs code-behind files**: Use `.razor.cs` files for component logic instead of @code blocks in `.razor` files.
31-
13. **Prefer razor.scss files**: Use `.razor.scss` files for component styles instead of inline styles in `.razor` files.
30+
11. **Prefer razor.cs code-behind files**: Use `.razor.cs` files for component logic instead of @code blocks in `.razor` files.
31+
12. **Prefer razor.scss files**: Use `.razor.scss` files for component styles instead of inline styles in `.razor` files.
3232

3333
### Rules for Using DeepWiki
3434

35-
The `deepwiki` MCP tool is essential for this project. Use it not only to answer questions but also to guide **code modifications**.
35+
The deepwiki's `ask_question` mcp tool is essential for this project. Use it not only to answer questions but also to guide **code modifications**.
3636
For the topics below, you **MUST** consult `deepwiki` to find correct implementations and usage patterns before writing or changing any code.
3737

3838
**RULE 1:** If a task (which includes answering a question or performing a code modification) involves the use of bit BlazorUI components (e.g., `BitButton`, `BitTooltip`, `BitTextField`), or refers to `bitplatform`, `bit Bswup`, `bit Butil`, `bit Besql`, or `bit Boilerplate`,
39-
you **MUST** use the `deepwiki` mcp tool to find the correct implementation and usage patterns before writing or changing any code.
39+
you **MUST** use the deepwiki's `ask_question` mcp tool to find the correct implementation and usage patterns before writing or changing any code.
4040

4141
**RULE 1 Command:**
4242
`deepwiki fetch bitfoundation/bitplatform`
4343

4444
**End of RULE 1**
4545

46-
**RULE 2:** If a task (question or code modification) involves mappers, or refers to `mapperly`, `map`, `project`, or `patch`, you **MUST** use the `deepwiki` mcp tool to find the correct implementation before writing or changing any code.
46+
**RULE 2:** If a task (question or code modification) involves mappers, or refers to `mapperly`, `map`, `project`, or `patch`, you **MUST** use the deepwiki's `ask_question` mcp tool to find the correct implementation before writing or changing any code.
4747

4848
**RULE 2 Command:**
4949
`deepwiki fetch riok/mapperly`
5050

5151
**End of RULE 2**
5252

53-
**RULE 3:** If a task (question or code modification) involves .NET MAUI, or refers to `xaml`, `Android`, `iOS`, or `Windows`, you **MUST** use the `deepwiki` mcp tool to find the correct implementation before writing or changing any code.
53+
**RULE 3:** If a task (question or code modification) involves .NET MAUI, or refers to `xaml`, `Android`, `iOS`, or `Windows`, you **MUST** use the deepwiki's `ask_question` mcp tool to find the correct implementation before writing or changing any code.
5454

5555
**RULE 3 Command:**
5656
`deepwiki fetch dotnet/maui`
5757

5858
**End of RULE 3**
5959

60-
**RULE 4:** If a task (question or code modification) involves Hangfire, or refers to `background job` or `recurring jobs`, you **MUST** use the `deepwiki` mcp tool to find the correct implementation before writing or changing any code.
60+
**RULE 4:** If a task (question or code modification) involves Hangfire, or refers to `background job` or `recurring jobs`, you **MUST** use the deepwiki's `ask_question` mcp tool to find the correct implementation before writing or changing any code.
6161

6262
**RULE 4 Command:**
6363
`deepwiki fetch HangfireIO/Hangfire`
6464

6565
**End of RULE 4**
6666

67-
**RULE 5:** If a task (question or code modification) involves file storage, or refers to `fluent storage` or `S3`, you **MUST** use the `deepwiki` mcp tool to find the correct implementation before writing or changing any code.
67+
**RULE 5:** If a task (question or code modification) involves file storage, or refers to `fluent storage` or `S3`, you **MUST** use the deepwiki's `ask_question` mcp tool to find the correct implementation before writing or changing any code.
6868

6969
**RULE 5 Command:**
7070
`deepwiki fetch robinrodricks/FluentStorage`

src/Templates/Boilerplate/Bit.Boilerplate/.vscode/settings.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"liveSassCompile.settings.watchOnLaunch": true,
33
"dotnet.defaultSolution": "Boilerplate.Web.slnf",
44
"dotnet.unitTests.runSettingsPath": "src/Tests/.runsettings",
5+
"github.copilot.chat.codesearch.enabled": true,
56
"csharp.preview.improvedLaunchExperience": true,
67
"explorer.fileNesting.enabled": true,
78
"explorer.fileNesting.patterns": {

0 commit comments

Comments
 (0)