d48cda4081
CI / Test (ubuntu-latest, Node 18.x, bun) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 18.x, npm) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 18.x, pnpm) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 18.x, yarn) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 20.x, bun) (push) Failing after 17m13s
CI / Test (ubuntu-latest, Node 20.x, npm) (push) Failing after 18m42s
CI / Test (ubuntu-latest, Node 20.x, pnpm) (push) Failing after 15m0s
CI / Test (ubuntu-latest, Node 20.x, yarn) (push) Failing after 49m44s
CI / Test (ubuntu-latest, Node 22.x, bun) (push) Failing after 51m55s
CI / Test (ubuntu-latest, Node 22.x, pnpm) (push) Failing after 21m57s
CI / Test (ubuntu-latest, Node 22.x, npm) (push) Failing after 37m39s
CI / Test (ubuntu-latest, Node 22.x, yarn) (push) Failing after 34m7s
CI / Validate Components (push) Failing after 37m15s
CI / Python Tests (push) Failing after 10m1s
CI / Security Scan (push) Failing after 10m1s
CI / Lint (push) Failing after 17m12s
CI / Coverage (push) Failing after 20m19s
CI / Test (macos-latest, Node 18.x, bun) (push) Has been cancelled
CI / Test (macos-latest, Node 18.x, npm) (push) Has been cancelled
CI / Test (macos-latest, Node 18.x, pnpm) (push) Has been cancelled
CI / Test (macos-latest, Node 18.x, yarn) (push) Has been cancelled
CI / Test (windows-latest, Node 18.x, npm) (push) Has been cancelled
CI / Test (windows-latest, Node 18.x, pnpm) (push) Has been cancelled
CI / Test (windows-latest, Node 18.x, yarn) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, bun) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, npm) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, pnpm) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, yarn) (push) Has been cancelled
CI / Test (windows-latest, Node 20.x, npm) (push) Has been cancelled
CI / Test (windows-latest, Node 20.x, pnpm) (push) Has been cancelled
CI / Test (windows-latest, Node 20.x, yarn) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, bun) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, npm) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, pnpm) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, yarn) (push) Has been cancelled
CI / Test (windows-latest, Node 22.x, npm) (push) Has been cancelled
CI / Test (windows-latest, Node 22.x, pnpm) (push) Has been cancelled
CI / Test (windows-latest, Node 22.x, yarn) (push) Has been cancelled
73 lines
2.0 KiB
Markdown
73 lines
2.0 KiB
Markdown
---
|
|
paths:
|
|
- "**/*.cs"
|
|
- "**/*.csx"
|
|
---
|
|
# C# Coding Style
|
|
|
|
> This file extends [common/coding-style.md](../common/coding-style.md) with C#-specific content.
|
|
|
|
## Standards
|
|
|
|
- Follow current .NET conventions and enable nullable reference types
|
|
- Prefer explicit access modifiers on public and internal APIs
|
|
- Keep files aligned with the primary type they define
|
|
|
|
## Types and Models
|
|
|
|
- Prefer `record` or `record struct` for immutable value-like models
|
|
- Use `class` for entities or types with identity and lifecycle
|
|
- Use `interface` for service boundaries and abstractions
|
|
- Avoid `dynamic` in application code; prefer generics or explicit models
|
|
|
|
```csharp
|
|
public sealed record UserDto(Guid Id, string Email);
|
|
|
|
public interface IUserRepository
|
|
{
|
|
Task<UserDto?> FindByIdAsync(Guid id, CancellationToken cancellationToken);
|
|
}
|
|
```
|
|
|
|
## Immutability
|
|
|
|
- Prefer `init` setters, constructor parameters, and immutable collections for shared state
|
|
- Do not mutate input models in-place when producing updated state
|
|
|
|
```csharp
|
|
public sealed record UserProfile(string Name, string Email);
|
|
|
|
public static UserProfile Rename(UserProfile profile, string name) =>
|
|
profile with { Name = name };
|
|
```
|
|
|
|
## Async and Error Handling
|
|
|
|
- Prefer `async`/`await` over blocking calls like `.Result` or `.Wait()`
|
|
- Pass `CancellationToken` through public async APIs
|
|
- Throw specific exceptions and log with structured properties
|
|
|
|
```csharp
|
|
public async Task<Order> LoadOrderAsync(
|
|
Guid orderId,
|
|
CancellationToken cancellationToken)
|
|
{
|
|
try
|
|
{
|
|
return await repository.FindAsync(orderId, cancellationToken)
|
|
?? throw new InvalidOperationException($"Order {orderId} was not found.");
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
logger.LogError(ex, "Failed to load order {OrderId}", orderId);
|
|
throw;
|
|
}
|
|
}
|
|
```
|
|
|
|
## Formatting
|
|
|
|
- Use `dotnet format` for formatting and analyzer fixes
|
|
- Keep `using` directives organized and remove unused imports
|
|
- Prefer expression-bodied members only when they stay readable
|