Skip to content

docs: add AI tool instruction files - #29

Merged
rsubrama83 merged 3 commits into
mainfrom
docs/ai-instruction-files
Oct 2, 2026
Merged

rsubrama83 merged 3 commits into
mainfrom
docs/ai-instruction-files

Conversation

@rsubrama83

@rsubrama83 rsubrama83 commented Oct 2, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Closes #21. Adds instruction files for AI tools, following the LM IT standard: one shared AGENTS.md, and thin tool-specific files that point to it.

File Read by Content
AGENTS.md (41 lines) Claude Code, Copilot, Codex, Cursor, humans project layout, key rules, commands, release workflow, current focus
CLAUDE.md (10 lines) Claude Code pointer to AGENTS.md + Claude-specific rules
.github/copilot-instructions.md GitHub Copilot (incl. code review) pointer to AGENTS.md + review checklist

Key rules captured in AGENTS.md

  • Breaking public API changes need a BREAKING CHANGE: footer
  • SkiaSharp / HarfBuzzSharp / NativeAssets.* stay on matching versions; native assets keep PrivateAssets="all" (Remove Native Assets from Nuget Package #18)
  • Grid's [Obsolete] marker is inherited from QuestPDF and may be reintroduced: do not remove it or migrate usages unprompted; NUnit Assert.That in tests (Replace Xceed Fluent Assertions #15)
  • Conventional Commits drive releases (feat/fix/breaking release, chore/test/docs don't); merge with a merge commit, not squash

Verified commands

dotnet build src/ShinyPDF.slnx, unit tests, example tests, and dotnet pack were all run successfully.

Also fixed (separate commit)

.devcontainer/devcontainer.json and .vscode/settings.json still pointed to src/ShinyPDF.sln, which no longer exists, so dotnet restore in the dev container's postCreateCommand failed. Both now point to src/ShinyPDF.slnx.

docs: / chore: commits, so merging does not trigger a release.

🤖 Generated with Claude Code

rsubrama83 and others added 2 commits October 2, 2026 13:45
AGENTS.md is the shared orientation file for all AI tools and humans:
project layout, key rules, verified commands and the release workflow.
CLAUDE.md and .github/copilot-instructions.md point to it and only add
tool-specific notes.

Closes #21

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The solution was migrated to src/ShinyPDF.slnx, but the dev container
restore command and the VS Code default solution still referenced the
removed src/ShinyPDF.sln.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Comment thread .github/copilot-instructions.md Outdated
Comment thread AGENTS.md Outdated
The [Obsolete] marker on Grid comes from the QuestPDF fork base and the
element may be reintroduced, so agents should neither avoid nor remove
it on their own. Drop the Grid check from the Copilot review list.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@rsubrama83
rsubrama83 merged commit 105644e into main Oct 2, 2026
1 check passed
@rsubrama83
rsubrama83 deleted the docs/ai-instruction-files branch October 2, 2026 12:04
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.

Add copilot and other ai tool instruction files

2 participants