Skip to content

Conversation

Copy link

Copilot AI commented Aug 18, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with detailed instructions for working effectively in this C# template repository.

Key Features

Prerequisites and Environment Setup

  • Exact commands for installing .NET 9.0 SDK (version 9.0.304) with timing expectations
  • Path configuration and verification steps
  • Measured installation time: 30-60 seconds with appropriate timeout warnings

Development Workflow

  • Complete project creation workflows for console apps, class libraries, web APIs, and test projects
  • Build, test, and run commands with measured timing (~5 seconds each)
  • Code formatting and linting using dotnet format with .editorconfig rules
  • Package management and project reference commands

Validation Scenarios

  • Step-by-step validation process that can be copy-pasted to verify the template works
  • Manual testing scenarios including creating, building, running, and testing projects
  • Expected outputs and timing for each step

Comprehensive Command Reference

  • Solutions and project management
  • Publishing and deployment options
  • Common NuGet packages and their installation commands
  • Web development specific guidance including hot reload (dotnet watch)
  • Performance and diagnostic commands

Configuration Documentation

  • Explanation of key files: global.json, Directory.Build.props, .editorconfig
  • Project structure and dev container configuration
  • Troubleshooting guidance for common issues

Validation

All instructions have been thoroughly tested by:

  • Following the complete validation workflow step-by-step
  • Testing multiple project types (console, class library, web API, xUnit tests)
  • Verifying build times, test execution, and code formatting
  • Ensuring all commands work correctly in the current environment

The instructions start with a firm directive to reference them first before falling back to search or bash commands, ensuring agents work efficiently with known-good workflows.

Fixes #23.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

…sitory

Co-authored-by: SIkebe <17608272+SIkebe@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for C# template repository Aug 18, 2025
Copilot AI requested a review from SIkebe August 18, 2025 05:05
Copilot finished work on behalf of SIkebe August 18, 2025 05:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants