Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Sep 14, 2025

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:

  • Exact commands for restore, build, and test with measured timing expectations
  • Critical timeout warnings (60+ seconds for builds, 30+ seconds for tests)
  • Primary .NET CLI approach vs legacy Cake build system guidance
  • Release build and NuGet packaging instructions

Validation Requirements:

  • Manual validation code examples using the library's fluent API
  • Complete test suite information (521 tests, ~5 seconds runtime)
  • Zero-warning build requirements matching CI expectations

Project Navigation:

  • Key directories, files, and architectural components
  • Important classes like DiffBuilder, IDiff, and core diffing strategies
  • Dependencies and target framework information

Measured Performance Expectations:
All timing values were validated through actual execution:

  • dotnet restore: ~11 seconds
  • dotnet build: ~15 seconds
  • dotnet test: ~5 seconds (521 tests)
  • Complete clean rebuild: ~18 seconds
  • Release packaging: ~9 seconds

Example Usage:

var control = @"<p attr=""foo"">hello <em>world</em></p>";
var test = @"<p attr=""bar"">hello <strong>world</strong></p>";

var diffs = DiffBuilder
    .Compare(control)
    .WithTest(test)
    .Build()
    .ToList();

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
    • Triggering command: /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.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Co-authored-by: egil <105649+egil@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for AngleSharp.Diffing development Sep 14, 2025
@Copilot Copilot AI requested a review from egil September 14, 2025 18:16
Copilot finished work on behalf of egil September 14, 2025 18:16
@egil egil marked this pull request as ready for review September 15, 2025 08:19
@Copilot Copilot AI review requested due to automatic review settings September 15, 2025 08:19
@egil egil merged commit 4de430b into devel Sep 15, 2025
3 of 7 checks passed
Copy link

@Copilot Copilot AI left a 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.
Copy link

Copilot AI Sep 15, 2025

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.

Suggested change
- 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
Copy link

Copilot AI Sep 15, 2025

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.

Suggested change
dotnet pack --configuration Release # ~8 seconds - creates NuGet packages
dotnet pack --configuration Release # 8 seconds - creates NuGet packages

Copilot uses AI. Check for mistakes.

@egil egil deleted the copilot/fix-52 branch September 15, 2025 09:21
egil added a commit that referenced this pull request Sep 15, 2025
…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>
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

3 participants