Skip to content

Commit 7e27812

Browse files
committed
first stab at RESEARCH.md
1 parent efde473 commit 7e27812

File tree

2 files changed

+1455
-0
lines changed

2 files changed

+1455
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,18 @@ Please verify that your issue is not being currently addressed by other issues o
2020
## Use of agents
2121
PR's with agent-generated code are fine. But don't spam us with code you don't understand. See [AGENTS.md](./AGENTS.md) for how we use LLMs in this repo.
2222

23+
## Understanding the codebase architecture
24+
If you're new to the CausalPy codebase or planning to make significant contributions, we strongly recommend reading [RESEARCH.md](./RESEARCH.md). This developer-oriented guide provides:
25+
26+
- An overview of the package architecture and how modules interact
27+
- Details on core abstractions (`BaseExperiment`, `PyMCModel`, etc.)
28+
- Public vs. internal API boundaries
29+
- Step-by-step guides for adding new experiment designs or models
30+
- Testing conventions and quality standards
31+
- Known limitations and areas needing improvement
32+
33+
This document serves as a "map" of the codebase and will help you understand where your contributions fit in the overall architecture.
34+
2335
## Contributing code via pull requests
2436

2537
While issue reporting is valuable, we strongly encourage users who are inclined to do so to submit patches for new or existing issues via pull requests. This is particularly the case for simple fixes, such as typos or tweaks to documentation, which do not require a heavy investment of time and attention.

0 commit comments

Comments
 (0)