Skip to content

docs: fix stale facts in Claude instructions and dev docs - #45

Merged
franccesco merged 2 commits into
mainfrom
docs/prompt-audit-cleanup
Sep 24, 2026
Merged

franccesco merged 2 commits into
mainfrom
docs/prompt-audit-cleanup

Conversation

@franccesco

Copy link
Copy Markdown
Owner

Summary

An audit of CLAUDE.md and the .claude/agents/ subagent definitions found instructions that no longer match the code or contradict each other. This PR fixes them. No library code changes.

Changes

  • Type checker command: uv run pyright resolves to a global pyright that ignores [tool.basedpyright], so it doesn't check what CI checks. Replaced with uv run basedpyright in CLAUDE.md, code-quality-reviewer, version-control-engineer, README.md and CONTRIBUTING.md.
  • Release process (version-control-engineer): the release steps committed on main and ran git push origin main --tags, which contradicted the agent's own "Always create PRs for main" rule. They now go branch → PR → tag the merge commit, which matches how releases have actually been done. Removed the duplicate "Version Bump Process" and used the chore(release): bump version to X.Y.Z commit message from history.
  • Copied tool config (code-quality-reviewer): the ruff rule list had drifted (it was missing RUF and preview = true). Replaced it with a pointer to pyproject.toml and quality.yml.
  • Test references: fixed test IDs that don't exist (test_user_details, TestUserOperations::test_details) and fixture signatures that don't match conftest.py.
  • Feature template (api-feature-developer): added the *_transform mixin step that every operations class uses, and pointed to the headlines resource as the reference implementation.
  • Git commands: replaced the hardcoded v0.19.0..HEAD and v0.18.0..HEAD ranges with the latest tag, and removed git rebase -i, which can't run in Claude Code's non-interactive shell.
  • Delegation section (CLAUDE.md): removed the IMPORTANT / PROACTIVELY emphasis and the subagent table (the harness already lists the agents). Added the reason for delegating and an exception for one- or two-line changes.

Test plan

  • uv run basedpyright: 0 errors
  • uv run pytest tests/test_users.py::TestUserOperations::test_details_basic passes
  • No remaining uv run pyright, stale test IDs, hardcoded tag ranges or rebase -i in the changed files
  • Next Claude Code session: confirm feature work still goes to subagents and one-line edits are made directly

🤖 Generated with Claude Code

franccesco and others added 2 commits September 24, 2026 11:44
Audit CLAUDE.md and the .claude/agents subagent definitions for
outdated content:

- Use `uv run basedpyright`; `uv run pyright` falls through to a global
  pyright that ignores the [tool.basedpyright] config CI uses (also
  fixed in README and CONTRIBUTING)
- Release steps go through a PR and tag the merge commit, matching the
  PR-only rule and actual history; drop the duplicate bump procedure
- Replace copied ruff/pyright config with a pointer to pyproject.toml
- Fix nonexistent test IDs and fixture signatures
- Add the transform-mixin step to the feature template
- Replace hardcoded tag ranges, drop `git rebase -i`
- Remove emphasis and the subagent table from the delegation section

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
- Point code-quality-reviewer to pyproject.toml and quality.yml instead
  of listing CI steps; consult them only when a setting is in question
- Add the transform mixin to api-feature-developer's checklist and drop
  the Step 2 text that repeated the overview
- Align version-control-engineer's commit example with the release
  steps, create the release branch first, and remove redundant steps
- Name sdk-test-engineer fixtures and point to conftest.py instead of
  copying their signatures

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@franccesco
franccesco merged commit 1aa8831 into main Sep 24, 2026
9 checks passed
@franccesco
franccesco deleted the docs/prompt-audit-cleanup branch September 24, 2026 17:48
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