Add ARCHITECTURE.md for agent and contributor onboarding#924
Merged
Conversation
Agents and contributors currently spend significant time re-discovering the same structural facts about CausalPy (backend dispatch, experiment lifecycle, data contracts, formula pipeline). This adds a living architecture reference that can be read once at the start of a session. AGENTS.md now points to ARCHITECTURE.md and requires it to be updated alongside structural changes. Co-authored-by: Cursor <cursoragent@cursor.com>
drbenvincent
added
the
agents
drbenvincent
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #924 +/- ##
=======================================
Coverage 95.07% 95.07%
=======================================
Files 87 87
Lines 13701 13701
Branches 812 812
=======================================
Hits 13026 13026
Misses 479 479
Partials 196 196 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Collaborator
Author
|
I'm going to YOLO merge this, but tagging @cetagostini and @juanitorduz |
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
ARCHITECTURE.md— a living reference covering the backend dispatch system, experiment lifecycle, formula/data pipeline, data contracts, experiment & model inventories, extension guide, and key conventions/gotchas.AGENTS.mdto point agents at the architecture doc and require it to be kept in sync with structural changes.This eliminates the repeated cost of agents re-discovering CausalPy's internal architecture from scratch in every fresh session.
Test plan
Made with Cursor