8000 Set up project for AI assistance. · mysql-net/MySqlConnector@3da6f66 · GitHub
[go: up one dir, main page]

Skip to content

Commit 3da6f66

Browse files
committed
Set up project for AI assistance.
1 parent 3c77a6e commit 3da6f66

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

.github/copilot-instructions.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# AI Instructions
2+
3+
## Project Context
4+
5+
MySqlConnector is a high-performance ADO.NET Data Provider for MySQL.
6+
It implements the MySQL protocol and handles authentication, connection pooling, and data access.
7+
8+
## Key Conventions
9+
10+
### Code Style
11+
- follow Microsoft's C# coding conventions with the exception that field names are prefixed with `m_` and are specified at the end of the class definition
12+
- use C# nullable reference types and implicit usings
13+
- XML documentation required for public APIs
14+
- use tabs for indentation in *.cs files; use two spaces for indentation in XML and JSON files, including *.csproj files
15+
- follow the rules from `.editorconfig`
16+
- implement async methods using the IOBehavior pattern: sync and async methods delegate to a common implementation that takes an IOBehavior parameter and handles both I/O types
17+
18+
### Performance
19+
- minimize allocations in hot paths
20+
- use Span-based APIs wherever possible
21+
22+
### Testing
23+
- Test files should be located in corresponding test directories. Place unit tests in tests/MySqlConnector.Tests. Place integration tests in tests/IntegrationTests.
24+
- Test names should be descriptive and follow the pattern `CamelCaseShortDescription`.
25+
- Use xUnit for tests.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ project.lock.json
1111
_ReSharper.*
1212
TestResult.xml
1313
Thumbs.db
14+
.aider*
1415
*.csproj.user
1516
*.DotSettings.user
1617
.idea

0 commit comments

Comments
 (0)
0