Skip to content

Refresh CLAUDE.md: trim stale sections, add writing style and QA gate - #3963

Merged
T4rk1n merged 1 commit into
devfrom
docs/claude-md-refresh
Aug 28, 2026
Merged

Refresh CLAUDE.md: trim stale sections, add writing style and QA gate#3963
T4rk1n merged 1 commit into
devfrom
docs/claude-md-refresh

Conversation

@T4rk1n

@T4rk1n T4rk1n commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Summary

CLAUDE.md was written a while back and had drifted. This trims what's gone stale and adds the rules I actually want followed.

Removed

  • The "Required Reading" block that told the agent to read all six .ai/ docs at session start. It never really did, and reading everything up front isn't needed. Replaced with a short pointer: open the .ai/ doc that covers what you're touching.
  • The "Key Files" map. Grep beats a hand-kept list that goes stale.

Added

  • Writing Style: comments are a last resort (the code is Python, it should read on its own), no em/en dashes, straight ASCII only, plain words. Applies to comments, commits, PR text, reviews, and CHANGELOG.
  • Quality Gate: before calling a change done, prove it in a running app driven headless by dash_duo, leave an integration/acceptance test behind, and run a second-model review of the diff before handing back.

Docs only, no code touched.

Drop the mandatory .ai/ read-all list and the hand-kept key-files map (grep
beats a stale map). Add a writing-style section (comments as a last resort,
plain ASCII, no em dashes) and a quality gate: prove changes in a running app
with dash_duo, leave an integration/acceptance test behind, and get a
second-model review before handing work back.
@sonarqubecloud

Copy link
Copy Markdown

@T4rk1n
T4rk1n merged commit 1dd02e1 into dev Aug 28, 2026
34 checks passed
@T4rk1n
T4rk1n deleted the docs/claude-md-refresh branch August 28, 2026 22:16
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