Skip to content

chore: Added symlink to AGENTS.md for copilot#16663

Open
jamescrosswell wants to merge 1 commit intomasterfrom
copilot-symlink
Open

chore: Added symlink to AGENTS.md for copilot#16663
jamescrosswell wants to merge 1 commit intomasterfrom
copilot-symlink

Conversation

@jamescrosswell
Copy link
Collaborator

DESCRIBE YOUR PR

Adding a symlink to the AGENTS.md file that will be picked up by the copilot extension when using this to work with LLMs in vscode etc.

IS YOUR CHANGE URGENT?

  • None: Not urgent, can wait up to 1 week+

SLA

cc: @Flash0ver

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

@vercel
Copy link

vercel bot commented Mar 4, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Mar 4, 2026 0:40am
sentry-docs Ready Ready Preview, Comment Mar 4, 2026 0:40am

Request Review

@jamescrosswell jamescrosswell requested a review from Flash0ver March 4, 2026 00:32
@@ -0,0 +1 @@
../AGENTS.md No newline at end of file
Copy link

Choose a reason for hiding this comment

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

Bug: The file .github/copilot-instructions.md is being replaced with a text string instead of actual instructions or a symlink, which will break GitHub Copilot's functionality.
Severity: HIGH

Suggested Fix

Either create a proper Git symbolic link from .github/copilot-instructions.md to AGENTS.md (e.g., using ln -s), or revert the change and keep .github/copilot-instructions.md as a regular file containing the full Markdown instructions.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: .github/copilot-instructions.md#L1

Potential issue: The pull request modifies the `.github/copilot-instructions.md` file to
contain the literal string `../AGENTS.md`. GitHub Copilot expects this file to contain
Markdown content with instructions, not a text reference to another file. As a result,
if this change is merged, Copilot will fail to load its custom instructions for all
developers working on this repository, effectively breaking this feature. The author may
have intended to create a symbolic link, but the change as implemented creates a regular
file with incorrect content.

Did we get this right? 👍 / 👎 to inform future reviews.

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.

1 participant