Skip to content

Conversation

@elliott-with-the-longest-name-on-github
Copy link
Contributor

I've been playing around with Claude and Opencode, and they utilize AGENTS.md pretty 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.md with some other stuff, moved it to AGENTS.md, and symlinked .github/copilot-instructions.md to AGENTS.md.


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

@changeset-bot
Copy link

changeset-bot bot commented Jan 9, 2026

⚠️ No Changeset found

Latest commit: a21959f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@svelte-docs-bot
Copy link

@Conduitry
Copy link
Member

On Windows, in order for cloning this repo as actual symlink, you will need to (1) set the appropriate git config to enable core.symlinks, and then (2) set your computer to be in 'developer mode' so that you can create symlinks without elevated privileges (for whatever reason, they require elevated privileges by default). Are we concerned about this?

@elliott-with-the-longest-name-on-github
Copy link
Contributor Author

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" 😆

@Conduitry
Copy link
Member

Is copilot-instructions something that's likely to be read on people's locally checked-out copies of the code, or just in the GitHub web interface? If it's not going to be read locally, I'd actually tend to not worry about this. If it is going to be looked at locally, then ... I'd probably still also be okay with this, but might want to check with Simon who is probably the only maintainer who regularly works on Svelte on Windows and not under WSL.

@mquandalle
Copy link

Claude code doesn't support AGENTS.md anthropics/claude-code#6235, but only CLAUDE.md. It's possible to import another file using @import

@elliott-with-the-longest-name-on-github
Copy link
Contributor Author

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 AGENTS.md then" 😆 I think the "create a CLAUDE.md that imports AGENTS.md" workaround is fine for now, though

@elliott-with-the-longest-name-on-github
Copy link
Contributor Author

@Conduitry sorry, missed that comment -- for VSCode users who use Copilot chat, it likely will be read. Given the issue with CLAUDE.md below though I'm inclined to use natural language rather than a symlink just to make it easier

@elliott-with-the-longest-name-on-github
Copy link
Contributor Author

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

Choose a reason for hiding this comment

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

Suggested change
AGENTS.md
@AGENTS.md

Otherwise it isn't automatically included

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

@elliott-with-the-longest-name-on-github elliott-with-the-longest-name-on-github merged commit 17a4b5e into main Jan 9, 2026
25 checks passed
@elliott-with-the-longest-name-on-github elliott-with-the-longest-name-on-github deleted the elliott/add-agentsmd branch January 9, 2026 20:58
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.

5 participants