Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 22, 2025

This PR restores the AI instructions section that was removed in commit 17aac7a, but wraps it in XML comments to keep it hidden from regular README viewers while maintaining accessibility in the source code.

Changes

The restored content includes:

  • For AI Agents: Instructions pointing to the comprehensive GitHub Agentic Workflows documentation at .github/instructions/github-agentic-workflows.instructions.md
  • Prompt Template: Reference to the /create-agentic-workflow prompt template for GitHub Copilot Chat

Rationale

By wrapping this content in XML comments (<!-- -->), we achieve:

  1. Clean README rendering: The instructions don't appear when viewing the README on GitHub or in documentation
  2. Source code preservation: The information remains available in the raw markdown for AI agents and developers who need it
  3. Discoverability: AI agents that can read HTML comments in markdown files can still access these instructions

Testing

  • ✅ Build succeeds with no errors
  • ✅ All unit tests pass
  • ✅ No functional changes to the codebase
Original prompt

Restore AI instructions removed in this commit but wrap them in an XML comment.

17aac7a


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

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Restore AI instructions in XML comment format Restore AI instructions in README.md wrapped in XML comments Oct 22, 2025
Copilot AI requested a review from pelikhan October 22, 2025 09:06
@pelikhan pelikhan marked this pull request as ready for review October 22, 2025 09:07
@pelikhan pelikhan enabled auto-merge (squash) October 22, 2025 09:07
@pelikhan pelikhan disabled auto-merge October 22, 2025 09:07
@pelikhan pelikhan merged commit b088b2f into main Oct 22, 2025
6 checks passed
@pelikhan pelikhan deleted the copilot/restore-ai-instructions-xml-comment branch October 22, 2025 09:07
@github-actions
Copy link
Contributor

Agentic Changeset Generator triggered by this pull request.

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.

2 participants