Skip to content

Add Start Here section to CONTRIBUTING.md #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ishan4432 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Start Here section to CONTRIBUTING.md #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,23 @@ 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

### Architecture Overview

Claude Code Hooks → FastAPI Collector → Delta Engine → Anomaly Detection → Notifications

### Recommended Reading Order

config.py → models.py → delta_engine.py → anomaly.py

### Architecture Docs
- docs/phase1-architecture.md
- docs/phase2-architecture.md

### Good First Issues

https://github.com/roeimichael/ContextAnalyzerTerminal/labels/good%20first%20issue

## Understanding the Architecture

Expand Down