Set up Copilot instructions

[Copilot]

User description

Description

Resolves #2323

Adds .github/copilot-instructions.md to configure GitHub Copilot coding agent per best practices.

Contents:

• Project overview and repository structure
• Build/test commands (dotnet build, dotnet test, dotnet pack)
• Multi-targeting guidance (netstandard2.0 through net10.0, conditional compilation)
• Code style: C# preview, nullable settings, license header template
• Testing: xUnit + FluentAssertions + AutoFixture, WireMock for HTTP
• Source generators: [GenerateImmutable], [GenerateClone], [Exclude]
• Central package management via Directory.Packages.props
• PR checklist

Purpose

This pull request is a:

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Original prompt

---

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes ✨ Set up Copilot instructions #2324

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

---

PR Type

Documentation

---

Description

• Adds comprehensive Copilot instructions for RestSharp repository

• Documents project overview, structure, and build/test commands

• Provides guidance on multi-targeting, code style, and conventions

• Includes testing frameworks, source generators, and PR checklist

---

Diagram Walkthrough

flowchart LR
  A["Repository Setup"] -->|"Copilot Instructions"| B["copilot-instructions.md"]
  B -->|"Contains"| C["Project Overview"]
  B -->|"Contains"| D["Build/Test Commands"]
  B -->|"Contains"| E["Code Style & Conventions"]
  B -->|"Contains"| F["Testing Guidelines"]
  B -->|"Contains"| G["PR Checklist"]

Loading

File Walkthrough

Relevant files

Documentation

copilot-instructions.md Add comprehensive Copilot instructions for RestSharp          .github/copilot-instructions.md Creates new Copilot instructions file with comprehensive repository guidance Documents RestSharp project overview, architecture, and multi-targeting strategy Provides build/test commands, code style conventions, and license header template Includes testing frameworks (xUnit, FluentAssertions, AutoFixture), source generators, and PR checklist +113/-0

---

[cloudflare-workers-and-pages]

Deploying restsharp with    Cloudflare Pages

Latest commit:	37fbef5
Status:	✅  Deploy successful!
Preview URL:	https://e9e842e4.restsharp.pages.dev
Branch Preview URL:	https://copilot-set-up-copilot-instr.restsharp.pages.dev

View logs

[qodo-free-for-open-source-projects]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🟢	🎫 #2324 🟢 Configure Copilot instructions for the repository following GitHub's best practices documentation Create instructions file to help Copilot coding agent understand the repository structure and conventions
Codebase Duplication Compliance
🟢	No codebase code duplication found No new components were introduced in the PR code
Custom Compliance
🟢	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[qodo-free-for-open-source-projects]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Enable nullable reference types in tests Enable nullable reference types in test projects to improve null-safety and test quality. .github/copilot-instructions.md [58] -- Nullable reference types: Enabled in `/src`, disabled in `/test` +- Nullable reference types: Enabled in all projects (`/src` and `/test`) Apply / Chat Suggestion importance[1-10]: 6 __ Why: This is a valid suggestion that promotes better coding practices by enabling nullable reference types in tests, which can improve the overall quality and robustness of the test suite.	Low
	Remove unreleased .NET version from targets Remove the unreleased .NET 10.0 from the list of target frameworks to avoid potential confusion. .github/copilot-instructions.md [46] -- `net8.0`, `net9.0`, `net10.0` - Modern .NET +- `net8.0`, `net9.0` - Modern .NET [Suggestion processed] Suggestion importance[1-10]: 3 __ Why: While factually correct that .NET 10.0 is unreleased, targeting future versions is a common and often intentional practice for forward-looking projects, making this a low-impact suggestion based on preference.	Low
More

[qodo-free-for-open-source-projects]

Suggestion: Remove unreleased .NET version from targets

Suggested change

	- `net8.0`, `net9.0`, `net10.0` - Modern .NET
	- `net8.0`, `net9.0` - Modern .NET

[alexeyzimarev]

.NET 10 was released more than a month ago, the suggestion is invalid.