Skip to content

Add root CLAUDE.md with repository rules and guidelines - #570

Merged
tejas7777 merged 2 commits into
masterfrom
fix/569-root-claude-md
Oct 8, 2026
Merged

tejas7777 merged 2 commits into
masterfrom
fix/569-root-claude-md

Conversation

@tejas7777

Copy link
Copy Markdown
Contributor

Issue number: Close #569

Technical description of changes

Adds a root CLAUDE.md so Claude Code (and humans) have one checked-in guide to the repository. It covers:

  • What Morpheus does and its stack (FastAPI, SQLModel/Postgres, Celery/Redis, httpx, Sentry/Logfire, uv).
  • make commands, and how to run a single test file against the pytest-env DATABASE_URL / REDIS_URL defaults.
  • A layout table of app/, tests/ and packaging/.
  • Rules: sync endpoints and the thread-pool/DB-pool coupling, db.close() before slow work on hot endpoints, HttpMessageError classes, AdminAuth / UserSession, no DDL at boot (Postmortem: 2026-07-08 web boot crash-loop — boot-time trigger DDL blocked messages/events; move bootstrap DDL out of web boot #511), create_all never altering existing tables, pg ENUM create_type=False, the message_aggregation view, Celery task naming and backward compatibility, the small worker pool, morpheus-mail versioning, test fixtures and the mocked providers, ruff/ty style.
  • CI and the tag-triggered deploy.
  • The public-repository hygiene rule.
  • The local .claude/ tooling: .claude/ is gitignored, so the file documents the project-context and terminal-record skills (and the local commands) as present only where a clone has them.

Every statement was checked against the code at the branch tip. No code changes.

Description for the non-dev team to understand

Adds a written guide to the Morpheus code repository for developers and AI coding tools. Nothing changes in how emails or SMSs are sent.

Recreation Steps

Open CLAUDE.md at the repository root. Start Claude Code in a clone of this repository: the file loads automatically as project instructions.

Manual testing required

None. Reviewers may want to check the rules match how they expect the repository to be worked on.

Checklist

  • Issue number added
  • Tests (pytest, using the conftest fixtures - cli/db/dummy_server; no real external HTTP) — n/a, docs only
  • Coverage — n/a, no code changed
  • make lint passes (ruff + ty)
  • Docstrings clear; type hints on new/changed signatures — n/a
  • API surface: TC2 / provider / recipient contract impact stated (or "none") — none
  • Schema change (if any) has its one-off SQL / bootstrap story in the description — none
  • app/render changes: morpheus-mail package compatibility considered — none

🤖 Generated with Claude Code

Documents the stack, make commands, layout, API / schema / Celery / test
conventions, CI and deploy, the public-repository hygiene rule, and the
local .claude/ tooling (project-context and terminal-record skills).

Fixes #569

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@tejas7777 tejas7777 self-assigned this Oct 8, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@tejas7777
tejas7777 merged commit 7260506 into master Oct 8, 2026
6 checks passed
@tejas7777
tejas7777 deleted the fix/569-root-claude-md branch October 8, 2026 14:09
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.

Add root CLAUDE.md for Claude rules and guidelines

2 participants