dotnet-framework — правило для GitHub Copilot
Правило направляет Copilot при работе с проектами .NET Framework: учитывает формат .csproj, ограничения C# 7.3 и практики для асинхронного кода. Подключите его, чтобы агент не предлагал неподдерживаемый синтаксис.
.github/instructions/dotnet-framework.instructions.mdЧто делает dotnet-framework
Правило применяется к файлам *.csproj и *.cs. Оно просит сначала определить формат проекта: в legacy-проектах новые файлы нужно добавлять через <Compile>, а SDK-style проекты вести по их собственным соглашениям. Для сборки предписан msbuild /t:rebuild, а не dotnet build.
Код должен оставаться совместимым с C# 7.3: записи, глобальные using и другие более новые возможности исключены. Для асинхронного кода правило требует ConfigureAwait(false) в библиотеках и запрещает синхронное ожидание через .Result или .Wait(). Оно также задаёт рекомендации по датам, строкам, исключениям и освобождению ресурсов.
Правило запрещает агенту устанавливать или обновлять NuGet-пакеты: такие изменения нужно поручить пользователю через NuGet Package Manager в Visual Studio. Для проекта с C# новее 7.3 предложенный агентом синтаксис придётся отдельно сверять с целевой версией.
Какие задачи решает
- собрать проект .NET Framework командой
msbuild - добавить новый
.cs-файл в legacy-проект - заменить синтаксис новее C# 7.3 на совместимый
- избежать
.Resultи.Wait()в асинхронном коде - обработать настройки и строки подключения через
ConfigurationManager
Примеры запросов агенту
- Добавь
NewService.csв этот legacy-проект и обнови.csprojдля C# 7.3. - Проверь асинхронный код на
.Resultи.Wait()и исправь найденные места. - Подготовь сборку этого решения .NET Framework командой
msbuild /t:rebuild.
Как установить dotnet-framework
Вручную: положить файлы
.github/instructions/dotnet-framework.instructions.mdПоле applyTo задаёт, к каким файлам применять
Вручную: положить файлы
.claude/rules/dotnet-framework.mdПоле paths во frontmatter ограничивает файлы: applyTo из источника → paths
AGENTS.md
Codex читает AGENTS.md: вставьте текст правила туда
Вручную: положить файлы
.cursor/rules/dotnet-framework.mdcВо frontmatter: description, globs, alwaysApply. applyTo из источника → globs, иначе правило само не подключится
Вручную: положить файлы
.devin/rules/dotnet-framework.mdВручную: положить файлы
.clinerules/dotnet-framework.mdПо шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать
Вопросы о dotnet-framework
Как установить dotnet-framework в GitHub Copilot?
Добавьте файл правила в проект по пути .github/instructions/dotnet-framework.instructions.md.
Что делает dotnet-framework?
Правило задаёт Copilot ограничения и практики для проектов .NET Framework: от формата .csproj и сборки до C# 7.3, NuGet и асинхронного кода.
Можно ли поручить правилу обновить NuGet-пакеты?
Нет. Оно запрещает агенту устанавливать и обновлять пакеты и просит передать такие изменения пользователю для работы через NuGet Package Manager в Visual Studio.
Исходный текст
dotnet-framework.instructions.md · MIT
---
description: 'Guidance for working with .NET Framework projects. Includes project structure, C# language version, NuGet management, and best practices.'
applyTo: '**/*.csproj, **/*.cs'
---
# .NET Framework Development
## Build and Compilation Requirements
- Always use `msbuild /t:rebuild` to build the solution or projects instead of `dotnet build`
## Project File Management
### Legacy and SDK-Style Project Structure
Many .NET Framework projects use the legacy non-SDK project format, which differs significantly from modern SDK-style projects. However, SDK-style project files can also target .NET Framework, such as `net48` or `net472`. Check the `.csproj` format before applying project-file guidance:
- **Legacy non-SDK projects**: All new source files **MUST** be explicitly added to the project file (`.csproj`) using a `<Compile>` element
- Legacy non-SDK projects do not automatically include files in the directory like SDK-style projects
- Example: `<Compile Include="Path\To\NewFile.cs" />`
- **SDK-style projects**: If the project file has an `Sdk` attribute, use SDK-style conventions even when it targets .NET Framework
- Example: `<Project Sdk="Microsoft.NET.Sdk">`
- Uses `<TargetFramework>` instead of `<TargetFrameworkVersion>`
- Example: `<TargetFramework>net48</TargetFramework>`
- **No Implicit Imports in legacy projects**: Unlike SDK-style projects, legacy non-SDK projects do not automatically import common namespaces or assemblies
- **Build Configuration in legacy projects**: Contains explicit `<PropertyGroup>` sections for Debug/Release configurations
- **Output Paths in legacy projects**: Explicit `<OutputPath>` and `<IntermediateOutputPath>` definitions
- **Target Framework in legacy projects**: Uses `<TargetFrameworkVersion>` instead of `<TargetFramework>`
- Example: `<TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>`
## NuGet Package Management
- Installing and updating NuGet packages in .NET Framework projects is a complex task requiring coordinated changes to multiple files. Therefore, **do not attempt to install or update NuGet packages** in this project.
- Instead, if changes to NuGet references are required, ask the user to install or update NuGet packages using the Visual Studio NuGet Package Manager or Visual Studio package manager console.
- When recommending NuGet packages, ensure they are compatible with .NET Framework or .NET Standard 2.0 (not only .NET Core or .NET 5+).
## C# Language Version is 7.3
- This project is limited to C# 7.3 features only. Please avoid using:
### C# 8.0+ Features (NOT SUPPORTED):
- Using declarations (`using var stream = ...`)
- Await using statements (`await using var resource = ...`)
- Switch expressions (`variable switch { ... }`)
- Null-coalescing assignment (`??=`)
- Range and index operators (`array[1..^1]`, `array[^1]`)
- Default interface methods
- Readonly members in structs
- Static local functions
- Nullable reference types (`string?`, `#nullable enable`)
### C# 9.0+ Features (NOT SUPPORTED):
- Records (`public record Person(string Name)`)
- Init-only properties (`{ get; init; }`)
- Top-level programs (program without Main method)
- Pattern matching enhancements
- Target-typed new expressions (`List<string> list = new()`)
### C# 10+ Features (NOT SUPPORTED):
- Global using statements
- File-scoped namespaces
- Record structs
- Required members
### Use Instead (C# 7.3 Compatible):
- Traditional using statements with braces
- Switch statements instead of switch expressions
- Explicit null checks instead of null-coalescing assignment
- Array slicing with manual indexing
- Abstract classes or interfaces instead of default interface methods
## Environment Considerations (Windows environment)
- Use Windows-style paths with backslashes (e.g., `C:\path\to\file.cs`)
- Use Windows-appropriate commands when suggesting terminal operations
- Consider Windows-specific behaviors when working with file system operations
## Common .NET Framework Pitfalls and Best Practices
### Async/Await Patterns
- **ConfigureAwait(false)**: Always use `ConfigureAwait(false)` in library code to avoid deadlocks:
```csharp
var result = await SomeAsyncMethod().ConfigureAwait(false);
```
- **Avoid sync-over-async**: Don't use `.Result` or `.Wait()` or `.GetAwaiter().GetResult()`. These sync-over-async patterns can lead to deadlocks and poor performance. Always use `await` for asynchronous calls.
### DateTime Handling
- **Use DateTimeOffset for timestamps**: Prefer `DateTimeOffset` over `DateTime` for absolute time points
- **Specify DateTimeKind**: When using `DateTime`, always specify `DateTimeKind.Utc` or `DateTimeKind.Local`
- **Culture-aware formatting**: Use `CultureInfo.InvariantCulture` for serialization/parsing
### String Operations
- **StringBuilder for concatenation**: Use `StringBuilder` for multiple string concatenations
- **StringComparison**: Always specify `StringComparison` for string operations:
```csharp
string.Equals(other, StringComparison.OrdinalIgnoreCase)
```
### Memory Management
- **Dispose pattern**: Implement `IDisposable` properly for unmanaged resources
- **Using statements**: Always wrap `IDisposable` objects in using statements
- **Avoid large object heap**: Keep objects under 85KB to avoid LOH allocation
### Configuration
- **Use ConfigurationManager**: Access app settings through `ConfigurationManager.AppSettings`
- **Connection strings**: Store in `<connectionStrings>` section, not `<appSettings>`
- **Transformations**: Use web.config/app.config transformations for environment-specific settings
### Exception Handling
- **Specific exceptions**: Catch specific exception types, not generic `Exception`
- **Don't swallow exceptions**: Always log or re-throw exceptions appropriately
- **Use using for disposable resources**: Ensures proper cleanup even when exceptions occur
### Performance Considerations
- **Avoid boxing**: Be aware of boxing/unboxing with value types and generics
- **String interning**: Use `string.Intern()` judiciously for frequently used strings
- **Lazy initialization**: Use `Lazy<T>` for expensive object creation
- **Avoid reflection in hot paths**: Cache `MethodInfo`, `PropertyInfo` objects when possible
© github · MIT · github/awesome-copilot