Skip to content

[ENG-3666] Add comment and explanation guidance for agents - #163

Merged
devlob merged 1 commit into
mainfrom
renatoh/eng-3666-comment-and-ticket-ref-guidance
Aug 21, 2026
Merged

[ENG-3666] Add comment and explanation guidance for agents#163
devlob merged 1 commit into
mainfrom
renatoh/eng-3666-comment-and-ticket-ref-guidance

Conversation

@devlob

@devlob devlob commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

What this does

Adds a ## Comments and Explanations section to CLAUDE.md, with three rules:

  • No ticket IDs anywhere in the tree — not in comments, docblocks, test names, config files or strings. The ID belongs in the PR title and the Closes line, which is where people go looking for the backstory, and git blame gets them there from any line.
  • Comments describe the code that is there, not the code that used to be. Narrating the old bug is the PR's job.
  • Explanations stay in plain language — short sentences, ordinary words.

The section is byte-identical to the one going into saas and hub, 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]+' over src, tests and field-test returns 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-3568 discloses nothing on its own.

Verification

Check Result
npm test 1296 passed, 6 skipped (106 files)
npm run typecheck clean, 8 templates OK

Ref ENG-3666

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.
@coderbuds

coderbuds Bot commented Aug 21, 2026

Copy link
Copy Markdown

Clear, concise documentation additions improving comment guidelines.

🎯 Quality: 98% Elite · 📦 Size: Small

📈 This month: Your 54th PR — above team average · Averaging Excellent

See how your team is trending →

@devlob

devlob commented Aug 21, 2026

Copy link
Copy Markdown
Contributor Author

/review

@devlob
devlob merged commit a3330e5 into main Aug 21, 2026
6 checks passed
@devlob
devlob deleted the renatoh/eng-3666-comment-and-ticket-ref-guidance branch August 21, 2026 12:26
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.

2 participants