[ENG-3666] Add comment and explanation guidance for agents - #163
Merged
Conversation
Adds a Comments and Explanations section to CLAUDE.md, matching saas and hub: no ticket IDs in the tree, comments describe the code that is there rather than the code that used to be, and explanations stay in plain language. This repo is public, so the section also says that nothing committed here may carry customer names, internal URLs or internal hostnames. No references needed removing — the tree was already clean.
|
Clear, concise documentation additions improving comment guidelines. 🎯 Quality: 98% Elite · 📦 Size: Small 📈 This month: Your 54th PR — above team average · Averaging Excellent |
Contributor
Author
|
/review |
daniloradovic
approved these changes
Aug 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this does
Adds a
## Comments and Explanationssection toCLAUDE.md, with three rules:Closesline, which is where people go looking for the backstory, andgit blamegets them there from any line.The section is byte-identical to the one going into
saasandhub, so it diffs cleanly when we amend it.Because this repo is public, it carries one extra line the others do not: nothing committed here may contain customer names, internal URLs or internal hostnames.
Why
From the team thread: we ship 20–30 PRs a day, and ticket IDs sprinkled through the code make the diffs harder to read while meaning nothing to anyone without Linear open. Dave asked specifically for this repo to be covered, since it is the public one.
Nothing needed removing
git grep -Ini -E '(eng|lab)-[0-9]{3,4}|nightwatch #[0-9]+'oversrc,testsandfield-testreturns nothing — the tree was already clean. This is a guideline change only, so the rule keeps it that way.The ticket ID stays allowed in PR titles here, same as the other repos. About a third of this repo's merged PRs already carry one, and a bare
ENG-3568discloses nothing on its own.Verification
npm testnpm run typecheckRef ENG-3666