Skip to content

Add AGENTS.md with guidance for AI coding agents - #123

Merged
FlorianRappl merged 1 commit into
AngleSharp:develfrom
lahma:ai-guidance
Jul 27, 2026
Merged

FlorianRappl merged 1 commit into
AngleSharp:develfrom
lahma:ai-guidance

Conversation

@lahma

@lahma lahma commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Adds an AGENTS.md describing what an AI agent has to know to be useful in this repository, and a CLAUDE.md that only imports it (@AGENTS.md) so Claude Code and other agents read the same file instead of each getting their own copy.

Contents:

  • Commands — the NUKE targets, plus the faster plain-SDK loop and the -f net8.0 filter for running a single fixture without repeating everything on net462/net472. Notes that the version comes from the top of CHANGELOG.md and that warnings are errors.
  • Architecture — how WithJs() wires into AngleSharp, one engine per window, that the exposed JS surface follows the services registered in the browsing context, the four proxy types, and the type-to-prototype canonicalization that makes instanceof work.
  • Performance — that it is a primary concern here, the cache-everything-reflective and do-it-on-first-use patterns the recent work established, the .NET techniques that apply, and the netstandard2.0/net462 constraint that rules out Span<T> and friends without a package reference.
  • Conventions — the parts of CONTRIBUTING.md that differ from ordinary modern C# (using inside the namespace, String over string, ConfigureAwait(false)).
  • Tests — the EvalScriptAsync idiom, the network-dependent fixtures, and a warning that Constants.cs is ~750 KB of embedded jQuery/React.

Documentation only; no code changes.

🤖 Generated with Claude Code

Documents the build and test commands, the reflection-based binding
architecture, the performance expectations, the AngleSharp code
conventions and the test idioms, so an agent does not have to rediscover
them from the sources every session.

CLAUDE.md only imports it, keeping one file for every agent.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

@FlorianRappl FlorianRappl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@FlorianRappl
FlorianRappl merged commit 0038d26 into AngleSharp:devel Jul 27, 2026
5 checks passed
@FlorianRappl FlorianRappl added this to the v1.0 milestone Jul 27, 2026
@lahma
lahma deleted the ai-guidance branch July 27, 2026 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants