Skip to content

ENG-8946: Add CLAUDE.md#1767

Open
carlosabadia wants to merge 1 commit intomainfrom
carlos/add-claude-md
Open

ENG-8946: Add CLAUDE.md#1767
carlosabadia wants to merge 1 commit intomainfrom
carlos/add-claude-md

Conversation

@carlosabadia
Copy link
Collaborator

No description provided.

@linear
Copy link

linear bot commented Mar 4, 2026

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 4, 2026

Greptile Summary

This PR adds a CLAUDE.md file to the repository root, providing context for AI coding assistants and developers about the project structure, tech stack, development commands, and code conventions for the reflex-web codebase.

The file is well-structured and covers essential areas needed for onboarding, including the project layout, key commands, dev-mode whitelist behavior, and preferred coding patterns. However, one factual inaccuracy was found: the tech stack section incorrectly lists Codespell as a pre-commit linting tool when it is not configured in .pre-commit-config.yaml. Only ruff-format and ruff are actually configured.

Confidence Score: 4/5

  • Safe to merge after correcting the inaccurate Codespell mention in the tech stack section.
  • The change is documentation-only (a new CLAUDE.md file), so there is no functional risk. One factual inaccuracy exists: Codespell is listed as a pre-commit tool when it is not configured in .pre-commit-config.yaml. This is a minor but concrete error worth fixing before merge to avoid misleading contributors and AI agents about what tooling is enforced.
  • CLAUDE.md — remove the Codespell mention on line 12, or add the Codespell pre-commit hook to .pre-commit-config.yaml if spell-checking should be enforced.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Clone repo] --> B[uv sync]
    B --> C{Dev or Prod?}
    C -->|Dev| D[uv run reflex run]
    C -->|Prod| E[uv run reflex run --env prod]
    D --> F[Edit pages/components]
    F --> G{Whitelist set?}
    G -->|Yes| H[Compile only whitelisted pages]
    G -->|No - empty list| I[Compile all pages]
    H --> J[uv run reflex compile]
    I --> J
    J --> K[uv run pytest tests/]
    K --> L[uv run pre-commit run --all-files]
    L --> M[Commit & push]
Loading

Last reviewed commit: 2572620

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