Skip to content

docs(claude): stop asking agents to re-generate the README - #2050

Merged
martin-helmich merged 1 commit into
masterfrom
docs/claude-md-skip-readme-regen
Jul 29, 2026
Merged

martin-helmich merged 1 commit into
masterfrom
docs/claude-md-skip-readme-regen

Conversation

@martin-helmich

Copy link
Copy Markdown
Member

CLAUDE.md currently instructs agents to run yarn generate:readme before every commit and as the last step of the wrap-up checklist.

That is redundant: the Update README for pull requests workflow (.github/workflows/readme_pr.yml) runs yarn generate:readme on every pull request (opened, ready_for_review, synchronize) and commits the regenerated README.md and docs/*.md back to the branch.

Changes:

  • Drop yarn generate:readme from the development commands list and from the wrap-up checklist.
  • Replace "Make sure to re-generate the documentation before each commit" with an explicit note not to do it, and why.

The wrap-up checklist (yarn lint → yarn compile → yarn test) is unaffected — yarn test does not include test:readme.

🤖 Generated with Claude Code

The "Update README for pull requests" workflow already re-generates
README.md and docs/*.md on every pull request and commits the result
back to the branch, so running `yarn generate:readme` locally is
redundant.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@martin-helmich
martin-helmich marked this pull request as ready for review July 29, 2026 08:53
@martin-helmich
martin-helmich merged commit 2e3feac into master Jul 29, 2026
11 of 12 checks passed
@martin-helmich
martin-helmich deleted the docs/claude-md-skip-readme-regen branch July 29, 2026 08:53
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.

1 participant