Skip to content

docs: add "Start Here" section to improve contributor onboarding #22

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
18mukeshram wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add "Start Here" section to improve contributor onboarding #22

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
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,30 @@

Thanks for your interest in contributing! CAT is an open-source project and we welcome contributions of all kinds.

## 🚀 Start Here

Welcome! If you're new to CAT, this section will help you quickly understand the project and how to start contributing.

### 🧭 What this project does

CAT (Context Analyzer Tool) is a system that processes incoming data, analyzes it for anomalies, and triggers notifications based on detected patterns.

### 🧠 How the system works (high-level)

The system follows a pipeline-based flow:

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

This modular architecture allows each component to focus on a specific responsibility.

### 📖 Recommended first steps

If you're new, follow this order:

1. Read the architecture overview below
2. Explore the recommended files (`config.py`, `models.py`, etc.) mentioned below
3. Pick a "good first issue" to start contributing

## New here? Start with a Good First Issue

We maintain a curated list of beginner-friendly issues — each one includes clear context, the files to look at, and a suggested approach:
Expand Down