Skip to content

chore(claude): add Claude Code project config and docs skeleton - #71

Merged
CowboyGH merged 4 commits into
developfrom
chore/claude-config
May 26, 2026
Merged

CowboyGH merged 4 commits into
developfrom
chore/claude-config

Conversation

@CowboyGH

@CowboyGH CowboyGH commented May 26, 2026 •

Copy link
Copy Markdown
Owner

Why

Set up Claude Code context files so Claude understands the project from the first session — stack, conventions, hard rules, and architecture — without needing to re-explain them each time.

What

  • CLAUDE.md — stack, commands, repo layout, conventions, hard rules, scope discipline, PR workflow, docs maintenance rules
  • .claude/rules/generated.md — never edit *.g.dart / *.freezed.dart / *.mocks.dart
  • .claude/rules/state.md — Cubit pattern, Result switch, test conventions
  • .claude/rules/widgets.md — _page.dart naming, const constructors, navigation rules
  • .claude/rules/tests.md — mockito (not mocktail), bloc_test, mirror structure
  • docs/architecture.md — layers, state machine, navigation redirect logic, DI order, storage
  • .gitignore — added CLAUDE.local.md

CowboyGH and others added 2 commits May 26, 2026 15:41
@CowboyGH CowboyGH self-assigned this May 26, 2026
@CowboyGH CowboyGH added the type: documentation Improvements or additions to documentation label May 26, 2026
@coderabbitai

coderabbitai Bot commented May 26, 2026 •

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

This pull request adds comprehensive project documentation and development conventions for the moveUP Flutter app. It introduces CLAUDE.md as the central project configuration file covering the tech stack, development commands, repository layout, and coding standards. Four detailed convention rule files specify constraints and patterns for generated code, state management with Cubits, testing frameworks, and widget construction. An extensive architecture documentation file describes the system design including Clean Architecture layers, state management patterns, navigation flow, networking stack, dependency injection, and storage management. Minor updates to .gitignore and CHANGELOG.md complete the documentation suite.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Whiskers twitching with documentation glee,
We've mapped the architecture for all to see,
Conventions recorded, conventions refined,
Clean layers and Cubits, all perfectly aligned,
The moveUP Flutter framework, now crystal clear and bright!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title accurately describes the main change: adding Claude Code configuration and documentation files to the project.
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 chore/claude-config

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CLAUDE.md`:
- Line 37: Update the canonical API filename suffix to match the architecture
doc by replacing the `_api.dart` mention with `*_api_client.dart` (the two
symbols to change are `_api.dart` -> `*_api_client.dart`) so the repository
guidance and `*_api_client.dart` convention are consistent for scaffolding and
new features.

In `@docs/architecture.md`:
- Around line 35-39: The fenced diagram block containing "Presentation  → 
Domain  ←  Data (Cubit, Page) (Entity, Repo iface) (DTO, ApiClient, RepoImpl,
Mapper)" needs a language identifier to satisfy markdownlint MD040; update the
fence from ``` to something like ```text (or ```plain) so the block is
explicitly marked as text while leaving the diagram content unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 4d9bd7ca-f738-46ba-bfcf-def01a179957

📥 Commits

Reviewing files that changed from the base of the PR and between 354c629 and 911e674.

📒 Files selected for processing (8)
  • .claude/rules/generated.md
  • .claude/rules/state.md
  • .claude/rules/tests.md
  • .claude/rules/widgets.md
  • .gitignore
  • CHANGELOG.md
  • CLAUDE.md
  • docs/architecture.md

Comment thread CLAUDE.md Outdated
Comment thread docs/architecture.md Outdated
@CowboyGH
CowboyGH merged commit cfec224 into develop May 26, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant