Skip to content

Share the Claude Code setup and fix outdated project docs - #2257

Closed
braulio-dev wants to merge 2 commits into
season-3from
claude-setup
Closed

braulio-dev wants to merge 2 commits into
season-3from
claude-setup

Conversation

@braulio-dev

@braulio-dev braulio-dev commented Sep 24, 2026 •

Copy link
Copy Markdown
Collaborator

Describe your changes

The project guide files for Claude Code were kept out of git, so every new worktree started without the module notes. Several of those notes also described classes that no longer exist. This puts one accurate, shared setup in the repo.

  • Project guide files are now part of the repo.
    • The root guide is instructions for Claude: finding code, when to ask, how to verify, review, ship and track work, plus the house rules.
    • A new architecture doc explains the project itself (modules, build, framework). It's read when needed, so the always-loaded guide stays short.
    • Module guides are short and point to where the detail lives.
  • Outdated notes are corrected.
    • Removed the clan levels section. That system isn't in the code.
    • Fixed skill types, clan ranks, game states and shop classes to match the code.
  • Long subsystem write-ups moved next to their code as README files.
    • Item access, cutscenes, sites, the network layer and sailing.
  • Placeholder domain files with no content are removed, and links to them fixed.
    • The real domain files (clans, champions, game, hub, progression, shops) stay.
  • Shared Claude Code helpers:
    • A check that flags rule breaks as code is written (hardcoded text, missing log submit, full class names, records, divider comments).
    • A compile check at the end of a turn. It only runs when Java or Kotlin changed, about 8 seconds warm.
    • Helpers for convention review, the Network Expansion board, Outline docs and library research.
    • A backlog skill with the board's field ids, plus the two champion skill tools.
  • Local Claude runtime files are now ignored.

Link to issue (if applicable)

Checklist before requesting a review

  • I have performed a self-review of my code
  • I have tested my changes.
    • Both checks tested with sample edits and a deliberate compile error in :lunar.

- Put the project guide files in the repo so every checkout and worktree gets them
  - They were local-only, so new worktrees never had the module notes
- Rewrite the project guide with the house coding and writing rules in one place
- Correct module notes that described classes and systems that don't exist
- Move long subsystem write-ups next to their code as README files
- Remove the placeholder domain files and fix links to them
- Add shared helpers for Claude Code
  - A check that flags rule breaks as code is written
  - A compile check at the end of each turn that only runs when code changed
  - Reviewer, backlog, Outline and API-research helpers
  - A backlog skill for the Network Expansion board
@github-actions

Copy link
Copy Markdown

Test Results

 69 files   69 suites   11s ⏱️
515 tests 512 ✅ 3 💤 0 ❌
523 runs  520 ✅ 3 💤 0 ❌

Results for commit 76bebf4.

@github-actions

Copy link
Copy Markdown

Test Results

 69 files   69 suites   8s ⏱️
515 tests 512 ✅ 3 💤 0 ❌
523 runs  520 ✅ 3 💤 0 ❌

Results for commit 76bebf4.

- The root guide now covers how to work here: finding code, when to ask, verify, review, ship and track
- The project overview (modules, build, framework) moves to its own architecture doc, read when needed
- Keeps the always-loaded guide short
@sonarqubecloud

Copy link
Copy Markdown

@braulio-dev
braulio-dev deleted the claude-setup branch September 25, 2026 00:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant