Skip to content

docs: add ONBOARDING.md — the process side of joining the team - #205

Merged
qiuethan merged 1 commit into
stagingfrom
qiuethan/Onboarding-Document
Aug 19, 2026
Merged

docs: add ONBOARDING.md — the process side of joining the team#205
qiuethan merged 1 commit into
stagingfrom
qiuethan/Onboarding-Document

Conversation

@qiuethan

Copy link
Copy Markdown
Collaborator

What this changes

Adds docs/ONBOARDING.md, the people-and-process side of joining as a contributor, plus one-line pointers in README.md and docs/DEVELOPMENT.md so it's discoverable from either direction.

Why

We're about to onboard devs. DEVELOPMENT.md covers the technical path and ACCESS.md covers credentials, but nothing covered how working here actually works: zone ownership expectations, how issues and the board work, PR review norms, the AI-tooling policy, and what's expected week to week. This doc fills that gap and repeats nothing technical — it links out instead.

Contents:

  • First-week checklist (access → read → make check green → zone assignment → first merged PR)
  • What owning a zone means: reviewer, issue triage, keeping the zone's docs honest
  • Getting work: self-serve ready issues, the three label axes (type/*, area/*, blocked/ready), the blocked/ready automation, claim = assign yourself, and the zone-vs-area distinction (issues are labeled by area; the zone link is just where the work will land)
  • PR norms: review-ready checklist, zone-owner reviews, 48h turnaround both directions, staging-first
  • AI-assisted development: AGENTS.md is the agent contract, you own every line, and ask @qiuethan if you're missing an AI tool you want
  • Time commitment: ~5 hrs/week baseline, 2-week quiet threshold before zones are reassigned, heads-ups keep zones held

Zone

docs, plus one pointer paragraph in root (README.md). Spans two zones because the README pointer is what makes the new doc discoverable; splitting a one-line pointer into its own PR would be noise.

How to verify

Read docs/ONBOARDING.md. Check the relative links resolve:

cd docs && grep -o '](\([^)#]*\)' ONBOARDING.md | sed 's/](//' | sort -u | \
  while read f; do [ -n "$f" ] && { [ -e "$f" ] && echo "OK $f" || echo "MISSING $f"; }; done

Expected: every line prints OK.

Checklist

  • Branched off staging and targeting staging.
  • Ran the test suite locally — docs-only change; no code touched.
  • ruff — not applicable, no Python touched.
  • Read and followed the relevant docs/CONTRIBUTING.md — docs-only change.
  • Docs updated in this PR where the change makes them wrong — this PR is the docs change; README and DEVELOPMENT.md pointers included.

🤖 Generated with Claude Code

https://claude.ai/code/session_01E4Waeq792GHzy42X6JCeCJ

DEVELOPMENT.md covers the technical path (clone → first merged change)
and ACCESS.md covers credentials, but nothing covered how working here
actually works. ONBOARDING.md fills that gap: a first-week checklist,
what owning a zone means (reviewer, triage, docs), how issues and the
board work (type/area/state label axes, blocked/ready automation,
claim = assign yourself), PR norms (review-ready checklist, zone-owner
reviews, 48h turnaround both directions, staging-first), the
AI-assisted development policy, and time-commitment expectations.

README.md and DEVELOPMENT.md get pointer lines so the doc is
discoverable from either direction.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01E4Waeq792GHzy42X6JCeCJ
@github-actions github-actions Bot added size/m < 200 lines changed zone: docs Owned by the docs zone (docs/CODE-OWNERSHIP.md) zone: root Owned by the root zone (docs/CODE-OWNERSHIP.md) and removed size/m < 200 lines changed labels Aug 19, 2026
@qiuethan
qiuethan merged commit 16bcb02 into staging Aug 19, 2026
16 checks passed
@qiuethan
qiuethan deleted the qiuethan/Onboarding-Document branch August 19, 2026 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

zone: docs Owned by the docs zone (docs/CODE-OWNERSHIP.md) zone: root Owned by the root zone (docs/CODE-OWNERSHIP.md)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant