Choose the smallest contribution you can finish
Describe a reproducible problem
Include what you expected, what happened, and the smallest steps that recreate it.
Share accessibility friction
Tell us where the flow became noisy, unclear, demanding, or difficult to recover from.
Clarify the documentation
A sentence that prevents one confusing setup detour is a valuable contribution.
Improve authentic examples
Help keep screenshots and instructions aligned with the real interface, without exposing personal study data.
Make a focused code change
Tests first, one problem per pull request, and public docs updated with learner-visible behaviour.
Help the community feel safe
Be kind and specific, assume the other person is tired, and never quote private learner material.
The Justfile is the front door
git clone https://github.com/NetDevAutomate/StudyLoop.git studyloop
cd studyloop
uv sync --all-packages --all-extras
uv run playwright install chromium
uv run pre-commit install
just preflightRun just e2e as well when changing the Web UI, session transports, or browser journeys. The browser suite uses an isolated home and fake agents for deterministic flows; opt-in live tests cover real providers separately.
Protect learner privacy
Never include credentials, transcripts, personal hostnames, local paths, or unredacted configuration in issues, fixtures, screenshots, or logs.
Keep the proof beside the change
A learner-visible behaviour change should include its nearest useful test, public documentation, and changelog entry.
Ready when you are
Read the full contributor guide
It covers repository structure, testing, CI, documentation standards, pull requests, AI usage, security, and conduct.