github-copilot-rules

```markdown
# GitHub Copilot AI Rule: Avoid Async Void Methods in .NET

## Rule Description
This rule enforces the use of `async Task` instead of `async void` for asynchronous methods in .NET. Async void methods cannot be awaited, making error handling and debugging significantly more difficult. This rule applies to all public and protected methods in your codebase.

## Why This Matters
- **Error Handling**: Exceptions thrown in async void methods cannot be caught by try/catch blocks, leading to unhandled exceptions.
- **Debugging**: Stack traces for async void methods are less informative, making it harder to identify the source of errors.
- **Thread Safety**: Async void methods can cause deadlocks or race conditions in multi-threaded scenarios.

## Correct Implementation
```csharp
public async Task FetchDataAsync()
{
    var data = await _httpClient.GetStringAsync("https://api.example.com/data");
    _logger.LogInformation("Data fetched successfully: {Data}", data);
}
```

## Incorrect Implementation
```csharp
public async void FetchDataAsync()
{
    var data = await _httpClient.GetStringAsync("https://api.example.com/data");
    _logger.LogInformation("Data fetched successfully: {Data}", data);
}
```

## How to Enforce This Rule
1. Add this rule to your `.github/copilot-rules.json` file:
```json
{
  "rules": [
    {
      "name": "Avoid Async Void Methods",
      "description": "Enforce async Task over async void for all methods.",
      "pattern": "async void",
      "severity": "error",
      "message": "Async void methods are not allowed. Use 'async Task' instead."
    }
  ]
}
```
2. Commit the file to your repository.
3. GitHub Copilot will now flag any violations of this rule in your code.
```