Skip to content

onboarding.md

Latest commit

 

History

History
129 lines (84 loc) · 5.54 KB

onboarding.md

File metadata and controls

129 lines (84 loc) · 5.54 KB
Raw

Contributor onboarding

Welcome. This doc is the fast path for your first PR. It links the existing guides rather than repeating them — read it once, then bookmark the references below.

Before you start

Doc What it covers
CONTRIBUTING.md Dev setup, code style, PR checklist, where to change each layer
docs/architecture.md Data flow, export state machine, dispatch table, frontend layout
docs/api-reference.md HTTP routes, error codes, field stability

Suggested reading order

Work through these in order before touching unfamiliar code:

  1. docs/architecture.md — component diagram, layers, and how JSONL becomes API + UI.
  2. utils/jsonl_parser.py — session parsing entry point; tool results flow through tool_dispatch.
  3. utils/tool_dispatch.py — priority-based _TOOL_RESULT_DISPATCH table; read the module docstring and dispatch table notes.
  4. Frontend SPA — static/js/app.js (routing), static/js/sessions.js (message panel), static/js/render/registry.js (tool renderers).

For API or export changes, also skim api/error_codes.py and utils/md_exporter.py.

First PR walkthrough

1. Fork and clone

# GitHub UI: fork cppalliance/claude-code-chat-browser to your account, then:
git clone https://github.com/<your-user>/claude-code-chat-browser.git
cd claude-code-chat-browser
git remote add upstream https://github.com/cppalliance/claude-code-chat-browser.git

2. Create a branch

Branch names follow feat/<topic>, fix/<topic>, docs/<topic>, etc. (see CONTRIBUTING.md).

git fetch upstream
git checkout -b docs/my-first-change upstream/master

3. Development setup

Follow CONTRIBUTING.md — Development setup for your OS (Python 3.12 venv, pip install -r requirements-dev.txt, optional Node 20+ for JS).

Smoke-test the dev server:

python app.py --port 5000
# Open http://127.0.0.1:5000

4. Make a focused change

  • One logical change per PR when possible.
  • Match existing conventions (ruff, import order, error_response() for API errors) — see Code style.
  • Add or update tests for behavior changes — see Tests required.

5. Run the full local gate

Run these locally before opening a PR. In CI, ruff (check + format --check) runs on Ubuntu, Windows, and macOS. mypy runs only in the Ubuntu job; run it locally before Python-heavy changes. pip-audit, pytest, integration tests, and Vitest also run on all three platforms in CI.

# Lint + format (CI: Ubuntu + Windows + macOS)
ruff check .
ruff format --check .

# Type check (CI: Ubuntu only)
mypy -p api -p utils -p models

# Security audit (production deps)
pip-audit -r requirements.txt

# Python tests (full suite)
pytest -q

# Integration subset (also run in CI)
pytest tests/test_api_integration.py -v

# Frontend — only if you changed static/js/
npm ci
npm run test:coverage

Fix formatting with ruff format . when ruff format --check fails.

6. Push and open a PR

git push -u origin docs/my-first-change

Open a pull request against master on cppalliance/claude-code-chat-browser. Include:

  • A short summary of why the change is needed.
  • A Test plan checklist (what you ran locally).
  • Links to any related issue (Fixes #NNN when applicable).

7. Review

.github/CODEOWNERS auto-requests reviewers on new PRs. Do not self-merge.

  1. Code review from @clean6378-max-it (Chen) or @timon0305 (Zilin). They own development and technical review on this repo.
  2. Final approval and merge from @wpak-ai (Will Pak) after code review is done.

Address review feedback in follow-up commits on the same branch.

Good first issues

Browse open issues filtered by label:

Not sure which issue to pick? Comment on an issue or open a draft PR early for CI feedback — see Getting help.

Maintainer coverage (bus factor)

Recent commit history is concentrated on a small set of identities. If those maintainers are unavailable, review and release can stall.

Mitigations in this repo:

  • .github/CODEOWNERS — @clean6378-max-it and @timon0305 for code review routing. Final merge approval (@wpak-ai) is enforced via branch protection.
  • This onboarding path — lowers the ramp for additional contributors to run gates and ship safely.

If you are joining as a reviewer, read the suggested reading order and run the full local gate once on master before approving your first PR.