Add AGENTS.md contributor guide + CLAUDE.md pointer - #268
Conversation
|
Any opinion ? They will only read it when they feel like it anyway... |
| ## Contributing | ||
|
|
||
| ### Before you commit | ||
| - Format with `cargo fmt --all`. The repo pins `rust-toolchain` (1.85.0), so bare |
There was a problem hiding this comment.
we're actually testing against 1.88 and don't pin the toolchain, we probably should
There was a problem hiding this comment.
well there is a rust-toolchain at dinghy top level...
There was a problem hiding this comment.
arf didn't see it, complicated week-end :P. probably a better idea not to have the 1.85.0 stated here, just saying the rust-toolchain file exist, should be less prone to the information becoming stale in the future
| @@ -0,0 +1,6 @@ | |||
| # CLAUDE.md | |||
There was a problem hiding this comment.
should this one just be an symbolic link to the agents.md file ? That way you're sure claude will have the content of it in its context. pointing it like that and you may have agents not bothering to read it (I have already seen this)
There was a problem hiding this comment.
i'm always worried about symlinks in git. what happens on nfs ?
There was a problem hiding this comment.
On NFS pretty sure no problems, on NTFS (windows) didn't try for a long time to be honnest.
From what i see there seems to be some options now if you enable developer mode in windows, set git config --global core.symlinks true before cloning the repo. looks like if you don't to that you just have a file with the target of the symlink in it. Won't prevent building dinghy and should be quite visible if someone makes a PR from an misconfigured windows pc
There was a problem hiding this comment.
yeah, i meant ntfs. all right. let's give it a try.
Overview code map + Contributing rules (code style, commit messages, inline/doc comments, PR bot/human interaction), adapted from tract. CLAUDE.md is a symlink to AGENTS.md so the content is always in context.
2 participants
Overview code map + Contributing rules (code style, commit messages, inline/doc comments, PR bot/human interaction), adapted from tract. CLAUDE.md just points at AGENTS.md.