Skip to content

docs: contributor onboarding path and CODEOWNERS#133

Merged
wpak-ai merged 6 commits into
masterfrom
docs/contributor-onboarding
Jul 15, 2026
Merged

docs: contributor onboarding path and CODEOWNERS#133
wpak-ai merged 6 commits into
masterfrom
docs/contributor-onboarding

Conversation

@clean6378-max-it

@clean6378-max-it clean6378-max-it commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

Closes #129
Most recent commits are from one person. If they're out, nobody else is obviously set up to review or ship.

Adds docs/onboarding.md with a first-PR path, reading order, and good-first-issue links. Points at CONTRIBUTING.md and architecture.md instead of copying them. .github/CODEOWNERS names @clean6378-max-it and @timon0305 for development and code review, and @wpak-ai for final approval and merge. README mentions the bus-factor risk briefly.

Docs only. Click through links in docs/onboarding.md and eyeball CODEOWNERS syntax. ruff check . should be unchanged.

Summary by CodeRabbit

  • Documentation
    • Added a contributor onboarding guide with a recommended reading order, first-PR walkthrough, development setup, testing steps, and review expectations (including beginner-friendly issue guidance).
    • Updated README, contributing guide, and architecture docs to reference the onboarding guide.
  • Chores
    • Added repository-wide code review ownership via CODEOWNERS to standardize reviewer assignment and merge/review expectations.
  • Documentation
    • Adjusted the Quick Start frontend test coverage command (npm run test:coverage) when static/js/ changes.

@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b95d4a16-0e84-41b9-8cf0-3f16bb461f66

📥 Commits

Reviewing files that changed from the base of the PR and between 3fe0de4 and 60d92f4.

📒 Files selected for processing (2)
  • README.md
  • docs/onboarding.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/onboarding.md

📝 Walkthrough

Walkthrough

Adds a contributor onboarding guide, links it from existing documentation, updates the frontend coverage command, and introduces repository-wide CODEOWNERS rules with documented review and merge enforcement expectations.

Changes

Contributor process

Layer / File(s) Summary
Contributor onboarding path
docs/onboarding.md, CONTRIBUTING.md, README.md, docs/architecture.md
Adds a first-PR walkthrough, suggested reading order, local validation commands, issue pointers, reviewer guidance, cross-references, and the frontend coverage test command.
Review routing and coverage
.github/CODEOWNERS
Defines two repository-wide code review owners and documents last-match behavior plus branch-protection and automation responsibilities.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: timon0305

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is concise and accurately summarizes the onboarding and CODEOWNERS changes.
Linked Issues check ✅ Passed The PR covers the onboarding guide, reading order, local gate, good-first-issues, CODEOWNERS, and bus-factor notes from #129.
Out of Scope Changes check ✅ Passed The changes stay within documentation and review-process updates and do not introduce source-behavior changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/contributor-onboarding

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/onboarding.md`:
- Around line 63-73: Update the “Run the full local gate” section in
onboarding.md to distinguish the cross-platform Ruff lint and format checks from
the Ubuntu-only mypy check. Clarify that Ruff runs on Ubuntu, Windows, and
macOS, while mypy runs only in the Ubuntu CI job, preserving the existing
commands.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5538e353-e859-4bdd-aaae-aeb4ff8e81aa

📥 Commits

Reviewing files that changed from the base of the PR and between f294fb9 and e5f1317.

📒 Files selected for processing (5)
  • .github/CODEOWNERS
  • CONTRIBUTING.md
  • README.md
  • docs/architecture.md
  • docs/onboarding.md

Comment thread docs/onboarding.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/CODEOWNERS:
- Around line 4-20: Update the CODEOWNERS entries for the repository,
documentation, contributor process, and CI/workflow paths to list only the
review owners `@clean6378-max-it` and `@timon0305`; remove `@wpak-ai` from these
ownership rules, leaving final approval, merge sequencing, and no-self-merge
enforcement to branch protection or automation.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 668b984e-eeb3-4a17-ae48-c9f52bfae4a3

📥 Commits

Reviewing files that changed from the base of the PR and between e5f1317 and ac2c4c0.

📒 Files selected for processing (3)
  • .github/CODEOWNERS
  • README.md
  • docs/onboarding.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/onboarding.md
  • README.md

Comment thread .github/CODEOWNERS Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
tests/benchmarks/conftest.py (1)

83-87: 🎯 Functional Correctness | 🔵 Trivial | 💤 Low value

Use a fixed anchor for the search benchmark corpus. datetime.now(UTC) makes the synthetic inputs drift between runs, which adds noise to benchmark comparisons; a fixed or injected anchor would keep the corpus stable.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@tests/benchmarks/conftest.py` around lines 83 - 87, Update the benchmark
corpus setup around the session timestamp generation to use a fixed or injected
anchor instead of datetime.now(UTC). Preserve the one-day offset and existing
timestamp formatting so every run produces stable synthetic session data.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@tests/benchmarks/conftest.py`:
- Around line 83-87: Update the benchmark corpus setup around the session
timestamp generation to use a fixed or injected anchor instead of
datetime.now(UTC). Preserve the one-day offset and existing timestamp formatting
so every run produces stable synthetic session data.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 42784b73-f633-45ef-b9c2-6a61352abe1d

📥 Commits

Reviewing files that changed from the base of the PR and between ac2c4c0 and a3a1e06.

📒 Files selected for processing (4)
  • .github/CODEOWNERS
  • README.md
  • docs/onboarding.md
  • tests/benchmarks/conftest.py
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/onboarding.md
  • README.md

@clean6378-max-it clean6378-max-it self-assigned this Jul 14, 2026
@clean6378-max-it clean6378-max-it requested review from timon0305 and wpak-ai and removed request for wpak-ai July 14, 2026 16:34
@timon0305

Copy link
Copy Markdown
Collaborator

This is a functional benchmark change in a PR whose body says "Docs only " and whose scope is onboarding/#129. It's also the root-case fix for the same flake #131 patched with all_history = 1. Split it into its own PR and reconsile with #131 or at minimum fix the "Docs only" claim and cross-reference #131

Comment thread tests/benchmarks/conftest.py Outdated
Comment thread tests/benchmarks/conftest.py Outdated
Comment thread .github/CODEOWNERS
Comment thread .github/CODEOWNERS Outdated
Comment thread docs/onboarding.md Outdated
Comment thread README.md Outdated
@clean6378-max-it

Copy link
Copy Markdown
Collaborator Author

This is a functional benchmark change in a PR whose body says "Docs only " and whose scope is onboarding/#129. It's also the root-case fix for the same flake #131 patched with all_history = 1. Split it into its own PR and reconsile with #131 or at minimum fix the "Docs only" claim and cross-reference #131

Reverted

@timon0305 timon0305 requested a review from wpak-ai July 14, 2026 21:18
Comment thread docs/onboarding.md Outdated
Comment thread docs/onboarding.md Outdated
Comment thread README.md
@clean6378-max-it clean6378-max-it requested a review from wpak-ai July 14, 2026 23:36
@wpak-ai wpak-ai merged commit 3eb3fe3 into master Jul 15, 2026
16 checks passed
@wpak-ai wpak-ai deleted the docs/contributor-onboarding branch July 15, 2026 06:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

claude-code-chat-browser: contributor onboarding path + CODEOWNERS for bus-factor mitigation

3 participants