# 🤝 Contributing to AI-SPM (Orbix)

Welcome—and thanks for taking the time to contribute 🙌  
This project focuses on **runtime security for AI systems (LLMs, agents, tools, and data flows)**.

---

# 🚀 Getting Started

## 1. Clone the repo
git clone https://github.com/dshapi/AI-SPM.git
cd AI-SPM

## 2. Run locally (Docker)
docker compose up --build

## 3. Access services
- UI → http://localhost:3000  
- API → http://localhost:8000  
- Grafana → http://localhost:3000  
- Prometheus → http://localhost:9090  

---

# 🧩 How to Contribute

We welcome:
- 🐛 Bug fixes  
- ✨ Features  
- 🔐 Security improvements  
- 📊 Observability enhancements  
- 🎨 UI/UX improvements  

---

# 🏷️ Label System

## 🔰 Onboarding
- good-first-issue
- help-wanted
- beginner-friendly

## 🧱 Type
- frontend
- backend
- fullstack
- docs
- security
- ai
- observability

---

# 📌 Open Issues (Contributor-Friendly)

## #2 Documentation Validation
- Review README
- Validate setup
- Fix outdated sections

## #3 Copy to Clipboard (Policy JSON)
- Add copy button
- Copy JSON
- Show toast

## #4 Fix Empty State Messaging
- Improve message
- Add CTA button

## #5 Live / Simulated Badge
- Add header badge
- Reflect system mode

## #6 Improve Error Toasts
- Standardize messages
- Add retry

## #7 Expose Garak Execution Logs
- Capture prompts
- Show in UI

## #8 Policy Explain API
- Add /policies/explain
- Return structured reason

## #9 WebSocket Reconnect
- Auto reconnect
- Show connection state

## #10 Prompt Deobfuscation
- Decode base64 / hex / URL

## #11 Risk Scoring
- Combine signals
- Output score

## #12 Escalate to Case
- Add /cases endpoint
- Persist data

## #13 Decision Trace Timeline
- Build trace pipeline
- Render UI timeline

## #14 Why Allowed Insights
- Explain safe decisions

## #15 Policy Improvement Suggestions
- Detect near misses
- Suggest improvements

## #16 Attack Phase Tagging
- Tag events: Recon → Exploit → Exfil

---

# ⭐ Final Note

This project is about:

Securing the future of AI systems in production.

Every contribution—small or large—moves that forward.
