TFX50 — Copilot Instructions

Estas regras não são sugestões, são diretrizes mandatórias. O objetivo é produzir código C# (.NET 8+) que seja, em ordem de prioridade: • Seguro: Inexpugnável contra ataques comuns. • Correto: Livre de bugs e lógica falha. • Performático: Rápido e com alocação de memória mínima (Zero-Allocation sempre que possível). • Claro: Legível e autoexplicativo, sem necessidade de comentários. • Consistente: Uniforme em todo o codebase. • Elegante: Esteticamente agradável e fácil de navegar. • Manutenível: Fácil de modificar e estender sem introduzir complexidade desnecessária. • Testável: Facilmente coberto por testes automatizados. • Escalável: Projetado para crescer com o sistema. • Sustentável: Baixo custo de manutenção a longo prazo. • Profissional: Reflete as melhores práticas da indústria. • Alinhado com o Negócio: Suporta os objetivos e requisitos do CrediSIS. • Documentado: Uso adequado de XML-Doc para APIs públicas. • Auditável: Facilita a rastreabilidade e conformidade. • Moderno: Aproveita os recursos mais recentes do C# e .NET 8+. • Eficiente: Minimiza o uso de recursos do sistema. • Testes Automatizados: Facilita a criação e manutenção de testes unitários e de integração. • Testes Unitários: Código deve ser facilmente testável com frameworks como xUnit, NUnit ou MSTest. • Testes de Integração: Facilita a criação de testes que verificam a interação entre componentes. • Teste Profundos: Código deve ser projetado para permitir testes profundos, incluindo mocks e stubs. • Cobertura de Testes: Código deve ser escrito de forma a maximizar a cobertura de testes automatizados. • Testabilidade: Código deve ser modular e desacoplado para facilitar a testabilidade. • Mockabilidade: Dependências devem ser injetadas para permitir o uso de mocks em testes. • Validações Finais: Sempre realize build e validação final do código antes de mesclar em branches principais. • Execução de Teste: Execute todos os testes automatizados antes de qualquer commit final. Padrões para orientar a escrita de código C# (.NET9 / C#13) e TypeScript neste repositório. O foco é legibilidade, performance e consistência.

• Classes (C# e TS): inglês, prefixo X, PascalCase. • Ex.: XUserService, XOrderProcessor. • Interfaces (C# e TS): inglês, prefixo XI, PascalCase. • Ex.: XIRepository, XIUserStore. • Métodos e propriedades: PascalCase. • Ex.: GetById, SaveChanges, LastAccessAt. • Campos (field) no corpo da classe: prefixo _ seguido de PascalCase. • Ex.: _Cache, _Repository, _MaxSize. • Parâmetros de métodos: p + PascalCase. • Ex.: pUserID, pOptions, pToken. • Variáveis locais: mnemônicas, abreviadas, tudo em minúsculo. • Ex.: lstua (lista de usuários ativos), frsrt (first read table). • Quando o nome original é abreviado, comp CEP, CPF, ID, URL, HTTP, JSON, XML, SQL, DB, UI, UX, deve manter caixa alta • Ex.: pUserID, GetByURL, LoadFromDB. • Nomes sempre em inglês para tipos, membros e arquivos. Esta é uma ampliação das suas instruções, focada em C# (.NET 8+), para que o Copilot (e qualquer desenvolvedor) siga padrões extremamente rigorosos de qualidade, performance, segurança, coerência e elegância. As novas seções estão marcadas e o conteúdo existente foi integrado e reforçado.

Aderência estrita a estas regras é fundamental para a legibilidade. • Classes, Structs, Enums, Records: PascalCase. • Ex.: UserService, OrderProcessor, CustomerStatus. • Interfaces: Prefixo I obrigatório, seguido de PascalCase. • Ex.: IRepository, IUserStore, IUnitOfWork. • Métodos e Propriedades: PascalCase. • Ex.: GetByIdAsync, SaveChanges, LastAccessAt, IsValid. • Campos (Fields) Privados: Prefixo _ obrigatório, seguido de PascalCase. • Ex.: _Cache, _Repository, _MaxSize. • Campos (Fields) Estáticos Privados: Prefixo s_ (para estático) seguido de PascalCase. • Campos (Fields) de Thread-Static: Prefixo t_ (para thread) seguido de PascalCase. • Variáveis Locais: camelCase (minúsculas). Devem ser curtas e mnemônicas. • Parâmetros de Métodos: p (de "parâmetro") seguido de PascalCase (como nos exemplos) ou camelCase simples. Seja consistente. O exemplo original usa pPascalCase. • Ex.: GetById(Guid pId), UpdateUser(User pUser).

O código deve ser limpo, vertical e com o mínimo de ruído visual. • Um Tipo por Arquivo: Mandatório. O nome do arquivo (.cs) deve ser idêntico ao do tipo principal (classe, interface, struct) que ele contém. • Sem Chaves em Blocos de Linha Única: if, else, foreach, while ou for que contenham apenas uma instrução não devem usar chaves ({}). • Ex.: if (pUser == null) return false; Retornos Antecipados (Early Returns): Mandatório. Use o padrão guard clause* para validar condições no início do método e retornar imediatamente. Isso reduz o aninhamento e a carga cognitiva. Sem Comentários: O código deve ser autoexplicativo. A necessidade de um comentário (// ou / */) indica que o código precisa ser refatorado para maior clareza (ex: extrair método, renomear variável). • Exceção Única: XML-Doc (<summary>) para APIs públicas e membros de interfaces é permitido, mas deve descrever o "quê" e não o "como". • Evitar Métodos Anônimos e Lambdas: Regra Crítica. Evite Func<>, Action<> e expressões lambda (=>) em caminhos de execução. Sempre prefira métodos nomeados (estáticos ou de instância). Isso melhora a legibilidade, facilita o debugging (profiling) e reduz alocações de delegate e closure*. Exceção:* Configuração de startup (ex: Program.cs) onde a legibilidade é o único foco e a performance não é crítica.