Skip to content

docs(claude): add configured lint/format/typecheck commands#21

Merged
alawein merged 2 commits into
mainfrom
docs/claude-md-refresh
May 31, 2026
Merged

docs(claude): add configured lint/format/typecheck commands#21
alawein merged 2 commits into
mainfrom
docs/claude-md-refresh

Conversation

@alawein

@alawein alawein commented May 31, 2026

Copy link
Copy Markdown
Owner

Add black/flake8/mypy commands (confirmed configured; ruff intentionally excluded).

Part of a portfolio-wide CLAUDE.md accuracy refresh (verified against each repo before editing; docs-only; pre-commit Docs Doctrine passed).

@coderabbitai review


Note

Low Risk
Documentation-only edits with no runtime, auth, or dependency behavior changes.

Overview
Updates CLAUDE.md with a last_updated / last-verified bump and a new Lint, format, and type-check section documenting black, flake8, and mypy (pointing at pyproject.toml where applicable).

Removes three placeholder docs under docs/architecture.md, deployment.md, and troubleshooting.md — that only contained TODO stubs and no real content.

Reviewed by Cursor Bugbot for commit d334ae3. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • Documentation
    • Updated development documentation with expanded build and test command guidance

@alawein

alawein commented May 31, 2026

Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented May 31, 2026

Copy link
Copy Markdown
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai

coderabbitai Bot commented May 31, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

CLAUDE.md documentation file receives two updates: metadata dates are refreshed to 2026-05-30, and the "Build and test commands" section is expanded to explicitly document linting, formatting, and type-checking steps using black, flake8, and mypy, with a note that configuration resides in pyproject.toml.

Changes

Documentation Maintenance

Layer / File(s) Summary
Metadata and build command documentation
CLAUDE.md
Metadata dates (last_updated, last-verified) are refreshed to 2026-05-30. Build and test command documentation is expanded with explicit lint, format, and type-check steps (black, flake8, mypy src) and a reference to pyproject.toml configuration.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A date refresh and commands refine,
Build steps now documented, clear as wine,
Black, flake8, mypy—all aligned,
In pyproject.toml, configs bind,
Small tweaks that help the work flow shine! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding documented lint/format/typecheck commands to CLAUDE.md, which is the primary focus of the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/claude-md-refresh

Comment @coderabbitai help to get the list of available commands and usage tips.

@alawein alawein merged commit 612a859 into main May 31, 2026
5 of 7 checks passed
@alawein alawein deleted the docs/claude-md-refresh branch May 31, 2026 07:11
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