Skip to content

Commit b06d6cf

Browse files
authored
Update CONTRIBUTING.md
Hi, I saw another PR (roeimichael#22). I’ve tried to improve clarity by adding explanations for each component. Happy to refine further.
1 parent 5c9607b commit b06d6cf

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,42 @@ We maintain a curated list of beginner-friendly issues — each one includes cle
99
**[Browse Good First Issues](https://github.com/roeimichael/ContextAnalyzerTerminal/labels/good%20first%20issue)**
1010

1111
These range from one-line bug fixes to small feature additions, and are a great way to get familiar with the codebase and dev workflow before tackling bigger tasks.
12+
## Start Here
13+
14+
If you're new to this project, follow this guide to get started quickly.
15+
16+
### Architecture Overview
17+
18+
The system processes data through the following pipeline:
19+
20+
Claude Code Hooks → FastAPI Collector → Delta Engine → Anomaly Detection → Notifications
21+
22+
### What Each Part Does
23+
24+
- **Hooks**: Capture events from Claude Code
25+
- **Collector**: Receives and stores incoming data
26+
- **Delta Engine**: Compares changes over time
27+
- **Anomaly Detection**: Detects unusual patterns
28+
- **Notifications**: Sends alerts
29+
30+
### Recommended Reading Order
31+
32+
To understand the codebase, read in this order:
33+
34+
1. `config.py` — configuration setup
35+
2. `models.py` — data structures
36+
3. `delta_engine.py` — core logic
37+
4. `anomaly.py` — anomaly detection
38+
39+
### Architecture Docs
40+
41+
- `docs/phase1-architecture.md`
42+
- `docs/phase2-architecture.md`
43+
44+
### Good First Issues
45+
46+
Start contributing here:
47+
https://github.com/roeimichael/ContextAnalyzerTerminal/labels/good%20first%20issue
1248

1349
## Understanding the Architecture
1450

0 commit comments

Comments
 (0)