This repository was archived by the owner on Jul 29, 2026. It is now read-only.
docs: update CLAUDE.md with git workflow and current conventions - #5
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates CLAUDE.md to better describe repository conventions for AI assistants, including workflow guidance and additional operational notes.
Changes:
- Adds an introductory preface and minor formatting/wording refinements for clarity.
- Adds new guidance sections for “Adding a New Ring”, “Working with EDCM”, and “Git Workflow”.
- Tweaks/relocates existing documentation about invariants, CI, known issues, and frontend.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **No `pytest-asyncio`.** Tests use `asyncio.run()` directly. Do not add `@pytest.mark.asyncio`. | ||
|
|
||
| **No `sys.path.insert` in source files.** `conftest.py` handles the path. Don't add it to individual modules. | ||
| **No `sys.path.insert` in source files.** `conftest.py` handles the path. Do not add it to individual modules. |
Comment on lines
98
to
+103
| GitHub Actions runs a single `build` job on every push with two steps: | ||
|
|
||
| 1. **flake8** — `--select=E9,F63,F7,F82` (syntax errors, undefined names). Must pass clean. | ||
| 2. **pytest** — all `test_*.py` and `tests_*.py` in `tests/`. Must pass. | ||
|
|
||
| Common CI failures seen: | ||
| Common CI failures: |
| 3. Add it to `state()["rings"]` under the same key | ||
| 4. **If scored:** add weight to `RING_WEIGHTS` and key to `_coherence_score()`'s `ring_scores` dict | ||
| 5. **If observer/optional:** skip `RING_WEIGHTS`; wrap access in `try/except` in `_inject()` and `reward()` | ||
| 6. Add checkpoint save/load in `save_checkpoint()` / `load_checkpoint()` (scored rings only) |
| React app in `frontend/`. Components: `TopologyVisualization`, `SystemHealthDashboard`, `EDCMArtifacts`, `LLMInterface`, `SMSConsole`. Not tested in CI. Backend served separately. | ||
| - Main branch: `main` | ||
| - Feature branches: `feat/<description>`, `fix/<description>`, `claude/update-from-interdependency-a0-*` | ||
| - Author: Erin Patrick Spencer |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary\n\n- Updates CLAUDE.md to add an explicit git workflow section (main branch, branch naming, author, license)\n- Preserves all existing ring module docs, key invariants, CI guidance, known stubs, and known issues\n- Minor formatting improvements for clarity\n\n## Test plan\n\n- [ ] Review for accuracy against current core/ and backend/ module structure\n- [ ] Verify CI step descriptions match .github/workflows/ configuration
Generated by Claude Code