-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
chore: Add AGENTS.md, symlink copilot instructions #15145
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: Add AGENTS.md, symlink copilot instructions #15145
Conversation
|
|
On Windows, in order for cloning this repo as actual symlink, you will need to (1) set the appropriate |
|
That's... insane. Another L for Windows, I guess. Maybe we can just make the contents of the symlinked file "please read this file instead" 😆 |
|
Is |
|
Claude code doesn't support |
|
Given they have literally thousands of thumbs-ups and virtual universal positive sentiment on that GitHub issue, I'm inclined to say "guess they'd better support |
|
@Conduitry sorry, missed that comment -- for VSCode users who use Copilot chat, it likely will be read. Given the issue with |
|
Nah, nevermind. If Windows users end up having a problem with it, we can consider using a different strategy. Otherwise... symlinks are literally for pointing files at other files. |
| @@ -0,0 +1 @@ | |||
| AGENTS.md No newline at end of file | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| AGENTS.md | |
| @AGENTS.md |
Otherwise it isn't automatically included
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nah, this is just GitHub's weird way of rendering symlinks. This is a symlink to AGENTS.md so when Claude reads the file it'll get the full contents of AGENTS.md without the intermediate step of having to read the file and @import it
17a4b5e
into
main
I've been playing around with Claude and Opencode, and they utilize
AGENTS.mdpretty effectively. If we add a code review bot in the future, it'll also utilize it. I went ahead and synthesized the stuff from.github/copilot-instructions.mdwith some other stuff, moved it toAGENTS.md, and symlinked.github/copilot-instructions.mdtoAGENTS.md.Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm testand lint the project withpnpm lintandpnpm checkChangesets
pnpm changesetand following the prompts. Changesets that add features should beminorand those that fix bugs should bepatch. Please prefix changeset messages withfeat:,fix:, orchore:.Edits