From b06d6cfd9bb035a00b1be1093c8d2fb851199877 Mon Sep 17 00:00:00 2001 From: ishan4432 Date: Wed, 29 Apr 2026 15:47:35 +0530 Subject: [PATCH] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Hi, I saw another PR (#22). I’ve tried to improve clarity by adding explanations for each component. Happy to refine further. --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8bbb8d6..5b0ff8c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,42 @@ We maintain a curated list of beginner-friendly issues — each one includes cle **[Browse Good First Issues](https://github.com/roeimichael/ContextAnalyzerTerminal/labels/good%20first%20issue)** 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. +## Start Here + +If you're new to this project, follow this guide to get started quickly. + +### Architecture Overview + +The system processes data through the following pipeline: + +Claude Code Hooks → FastAPI Collector → Delta Engine → Anomaly Detection → Notifications + +### What Each Part Does + +- **Hooks**: Capture events from Claude Code +- **Collector**: Receives and stores incoming data +- **Delta Engine**: Compares changes over time +- **Anomaly Detection**: Detects unusual patterns +- **Notifications**: Sends alerts + +### Recommended Reading Order + +To understand the codebase, read in this order: + +1. `config.py` — configuration setup +2. `models.py` — data structures +3. `delta_engine.py` — core logic +4. `anomaly.py` — anomaly detection + +### Architecture Docs + +- `docs/phase1-architecture.md` +- `docs/phase2-architecture.md` + +### Good First Issues + +Start contributing here: +https://github.com/roeimichael/ContextAnalyzerTerminal/labels/good%20first%20issue ## Understanding the Architecture