-
-
Notifications
You must be signed in to change notification settings - Fork 8
Add comprehensive GitHub Copilot instructions for AngleSharp.Diffing development #53
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Co-authored-by: egil <105649+egil@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive GitHub Copilot instructions to guide AI coding agents when working with the AngleSharp.Diffing codebase. The instructions provide detailed build workflows, validation requirements, and development best practices to help automated agents work effectively with this HTML comparison library.
- Establishes complete build and test workflows with timing expectations and warnings
- Provides manual validation code examples using the library's fluent API
- Documents project structure, key classes, and development standards
- `dotnet restore`: 11 seconds - NEVER CANCEL. Set timeout to 60+ seconds minimum. | ||
- `dotnet build`: 15 seconds - NEVER CANCEL. Set timeout to 60+ seconds minimum. | ||
- `dotnet test`: 5 seconds - runs 521 tests. NEVER CANCEL. Set timeout to 30+ seconds minimum. | ||
- Complete clean rebuild: ~20 seconds - NEVER CANCEL. Set timeout to 60+ seconds minimum. |
Copilot
AI
Sep 15, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Line 27 shows ~20 seconds for complete clean rebuild, but the sum of restore (11s) + build (15s) would be 26 seconds. Consider updating to ~26 seconds or explaining why it's faster when combined.
- Complete clean rebuild: ~20 seconds - NEVER CANCEL. Set timeout to 60+ seconds minimum. | |
- Complete clean rebuild: ~26 seconds - NEVER CANCEL. Set timeout to 60+ seconds minimum. |
Copilot uses AI. Check for mistakes.
```bash | ||
cd src | ||
dotnet build --configuration Release # ~15 seconds | ||
dotnet pack --configuration Release # ~8 seconds - creates NuGet packages |
Copilot
AI
Sep 15, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The comment indicates ~8 seconds but line 193 states ~8 seconds for 'Package creation'. Consider using consistent timing format (either 8 or ~8 seconds) throughout the document.
dotnet pack --configuration Release # ~8 seconds - creates NuGet packages | |
dotnet pack --configuration Release # 8 seconds - creates NuGet packages |
Copilot uses AI. Check for mistakes.
…iffing development (#53) * Initial plan * Add comprehensive GitHub Copilot instructions for AngleSharp.Diffing Co-authored-by: egil <105649+egil@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: egil <105649+egil@users.noreply.github.com>
This PR adds a comprehensive
.github/copilot-instructions.md
file that provides GitHub Copilot coding agents with detailed instructions for working effectively in the AngleSharp.Diffing codebase.What's Included
The instructions provide exhaustive guidance covering:
Build and Development Workflow:
.NET
CLI approach vs legacy Cake build system guidanceValidation Requirements:
Project Navigation:
DiffBuilder
,IDiff
, and core diffing strategiesMeasured Performance Expectations:
All timing values were validated through actual execution:
dotnet restore
: ~11 secondsdotnet build
: ~15 secondsdotnet test
: ~5 seconds (521 tests)Example Usage:
Validation
All instructions have been thoroughly validated by executing every command and code example to ensure they work correctly in the development environment. The instructions emphasize the imperative tone requested and include explicit "NEVER CANCEL" warnings for time-sensitive operations.
Fixes #52.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
esm.ubuntu.com
/usr/lib/apt/methods/https
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.