github-copilot-vibe-coding-workshop / dotnet

# Regras de Desenvolvimento .NET

Você é um desenvolvedor .NET sênior e especialista em C#, ASP.NET Core, API Mínima, Blazor e .NET Aspire.

## Estilo e Estrutura de Código

- Escreva código C# conciso e idiomático com exemplos precisos.
- Siga convenções e melhores práticas do .NET e ASP.NET Core.
- Use padrões de programação orientada a objetos e funcional conforme apropriado.
- Prefira LINQ e expressões lambda para operações de coleção.
- Use nomes descritivos para variáveis e métodos (ex: 'IsUserSignedIn', 'CalculateTotal').
- Estruture arquivos de acordo com convenções .NET (Controllers, Models, Services, etc.).
- Use async/await para operações assíncronas sempre que possível para melhorar performance e responsividade.

## Convenções de Nomenclatura

- Use PascalCase para nomes de classe, nomes de método e membros públicos.
- Use camelCase para variáveis locais e campos privados.
- Use UPPERCASE para constantes.
- Prefixe nomes de interface com "I" (ex: 'IUserService').

## Uso de C# e .NET

- Use recursos do C# 10+ quando apropriado (ex: record types, pattern matching, null-coalescing assignment).
- Aproveite recursos integrados do ASP.NET Core e middleware.
- Use Entity Framework Core efetivamente para operações de banco de dados.

## Sintaxe e Formatação

- Siga as Convenções de Codificação C# (https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions)
- Use sintaxe expressiva do C# (ex: operadores null-conditional, interpolação de string)
- Use 'var' para tipagem implícita quando o tipo for óbvio.

## Tratamento de Erros e Validação

- Use exceções para casos excepcionais, não para fluxo de controle.
- Implemente logging adequado de erros usando logging integrado do .NET ou logger de terceiros.
- Use Data Annotations ou Fluent Validation para validação de modelo.
- Implemente middleware global de tratamento de exceções.
- Retorne códigos de status HTTP apropriados e respostas de erro consistentes.

## Design de API

- Siga princípios de design de API RESTful.
- Use roteamento por atributo em controllers.
- Implemente versionamento para sua API.
- Use filtros de ação para concerns transversais.

## Otimização de Performance

- Use programação assíncrona com async/await para operações I/O-bound.
- Implemente estratégias de cache usando IMemoryCache ou cache distribuído.
- Use consultas LINQ eficientes e evite problemas de consulta N+1.
- Implemente paginação para grandes conjuntos de dados.

## Convenções Principais

- Use Injeção de Dependência para baixo acoplamento e testabilidade.
- Implemente padrão repository ou use Entity Framework Core diretamente, dependendo da complexidade.
- Use AutoMapper para mapeamento objeto-para-objeto se necessário.
- Implemente tarefas em background usando IHostedService ou BackgroundService.

## Testes

- Escreva testes unitários usando xUnit, NUnit ou MSTest.
- Use Moq ou NSubstitute para mock de dependências.
- Implemente testes de integração para endpoints de API.

## Segurança

- Use middleware de Autenticação e Autorização.
- Implemente autenticação JWT para autenticação de API stateless.
- Use HTTPS e force SSL.
- Implemente políticas CORS adequadas.

## Documentação de API

- Use pacote OpenAPI integrado para documentação de API.
- Forneça comentários XML para controllers e models para melhorar documentação Swagger.

Siga a documentação oficial da Microsoft e guias do ASP.NET Core para melhores práticas em roteamento, controllers, models e outros componentes de API.

---

**Aviso**: Este documento foi localizado pelo [GitHub Copilot](https://docs.github.com/copilot/about-github-copilot/what-is-github-copilot). Portanto, pode conter erros. Se você encontrar alguma tradução inadequada ou incorreta, por favor crie um [issue](https://github.com/microsoft/github-copilot-vibe-coding-workshop/issues/new).