copilot-instructions dotnet-csharp.instructions.md

Code Organization

• #region structure and order (top to bottom):
  • #region Constants - const fields
  • #region Static Variables - static fields
  • #region Static Properties - static properties
  • #region Variables - instance fields
  • #region Protected Properties - protected properties
  • #region Public Properties - public properties
  • #region Internal Properties - internal properties
  • #region Constructors - constructors
  • #region Public Methods/Operators - public methods and operators
  • #region Protected Methods/Operators - protected methods and operators
  • #region Internal Methods/Operators - internal methods and operators
  • #region Private Methods/Operators - private methods and operators
• Do not create empty regions. Only wrap members when there is at least one concrete member inside the region. If a type has no public methods, do not emit #region Public Methods/Operators at all.
• #region formatting: NO blank line after #region Description and NO blank line before #endregion. Implementation starts immediately after the region marker and ends immediately before endregion.
• #region spacing: ALWAYS add ONE blank line between #endregion and the next #region. Never place them adjacent without separation.
• ALWAYS use template .github/templates/dotnet-class-template.cs for classes
• ALWAYS use template .github/templates/dotnet-interface-template.cs for interfaces
• Do not assemble new classes or interfaces directly from the inline examples in this instruction; use the templates as the concrete file skeleton and treat examples here as partial guidance only.
• Small focused methods
• Single responsibility classes
• Avoid god classes
• Ensure namespaces match folder structure exactly; for .NET files follow the repository default EOF policy from .editorconfig (insert_final_newline = false) and never leave a trailing empty line at EOF

// follow .github/templates/dotnet-class-template.cs and .github/templates/dotnet-interface-template.cs when creating new types
// Replace placeholders, keep PascalCase naming, remove unused usings
namespace MyApp.Core
{
    public sealed class OrderService
    {
        private readonly IRepository _repo;
        public OrderService(IRepository repo) { _repo = repo; }
        public Task<Order> GetAsync(Guid id) => _repo.FindAsync(id);
    }
}