Skip to content

chore: add CLAUDE.md as symlink to AGENTS.md #65

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.

Sign up for GitHub

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

Merged
aliasunder merged 2 commits into from
Aug 24, 2026
Merged

chore: add CLAUDE.md as symlink to AGENTS.md #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70900eb
chore: add CLAUDE.md as symlink to AGENTS.md
aliasunder Aug 24, 2026
fef47ad
docs: add Windows core.symlinks note to CONTRIBUTING.md
aliasunder Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
AGENTS.md
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ inline findings. TypeScript inside, Node 24, strict mode throughout.
- Node.js 24 (an `.nvmrc` is provided — `nvm use`)
- Docker (for the image build check)

**Windows:** this repo uses symlinks (`CLAUDE.md → AGENTS.md`). Run
`git config core.symlinks true` before cloning, or re-clone after setting
it — otherwise Git checks out symlinks as plain text files containing the
target path.
Comment on lines +18 to +20

@umm-actually umm-actually Bot Aug 24, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Enable core.symlinks with --global before cloning
Low severity · correctness · high confidence

The instruction git config core.symlinks true before cloning cannot do what it promises: before a clone exists there is no repository to write the config into, so the command errors with 'fatal: not in a git directory' when run in the intended clone directory, and if run inside an existing repo it only configures that repo, not the new clone. A following clone therefore keeps the default false, and CLAUDE.md still checks out as a plain text file — contradicting the note's stated fix.

Failure scenario: A Windows user runs the documented command in their clone target directory: git fails with 'fatal: not in a git directory', the clone proceeds with core.symlinks=false, and CLAUDE.md checks out as a text file containing 'AGENTS.md', defeating the note's purpose.

Suggested fix 
Use the global scope so the setting applies to the new clone: `git config --global core.symlinks true` (and note that Windows also needs Developer Mode or an elevated shell for symlink creation to succeed).

umm-actually · deepseek/deepseek-v4-flash-0731


## Build & test

```bash
Expand Down