Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (40 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

54 lines (40 loc) · 1.3 KB
Raw

Contributing to Compass

Setup checklist

python -m pip install -e "packages/compass-core[dev,live]"
python -m pip install -r requirements-web.txt
# optional: [rag] [asr] [pdf] [studio]
cp .env.example .env
cd packages/compass-core && pytest -q

Windows: .\scripts\install.ps1

Run

python -m compass_core.cli studio --root content --port 7860
python -m compass_core.cli live --root content --port 8766
# Demo button when: set COMPASS_DEMO=1

Privacy red lines

Never commit under content/ except fixtures, .gitkeep, and examples.
Blocked: resumes, interviews, diagnoses, track boards, uploads, RAG indexes, oral logs.

Labels

Label Use
good first issue See docs/GOOD_FIRST_ISSUES.md
docs Documentation only
bank Question bank entries
ui Studio / Live front-end
core compass-core logic

LLM (optional)

set OPENAI_API_KEY=...
set COMPASS_LLM_PROVIDER=openai
set COMPASS_MODEL=gpt-4o-mini
python -m compass_core.cli llm-info

Without a key, follow-ups use rule templates.

PRs

  1. Keep changes focused; match existing style.
  2. Add/adjust tests for gate, followup, timeline, export.
  3. Update CHANGELOG for user-facing changes.
  4. Do not include personal job-search artifacts.