Skip to content

Docs/v0.3.0 onboarding and ownership#184

Merged
wpak-ai merged 3 commits into
cppalliance:mainfrom
jonathanMLDev:docs/v0.3.0-onboarding-and-ownership
Jun 29, 2026
Merged

Docs/v0.3.0 onboarding and ownership#184
wpak-ai merged 3 commits into
cppalliance:mainfrom
jonathanMLDev:docs/v0.3.0-onboarding-and-ownership

Conversation

@jonathanMLDev

@jonathanMLDev jonathanMLDev commented Jun 29, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Sync all consumer-facing README install/MCP config pins from 0.2.0 to 0.3.0 (matches package.json)
  • Add a Upgrading to 0.3.0 callout; keep historical 0.1.x → 0.2.0 migration text unchanged
  • Update CHANGELOG compare links and the current-pin example in docs/deprecation-policy.md
  • Add .github/CODEOWNERS with @wpak-ai and @jonathanMLDev on critical paths (src/, src/alliance/, package.json, .github/workflows/)
  • Add root CONTRIBUTING.md (prerequisites, dev setup, architecture overview, PR conventions, code style)
  • Point docs/CONTRIBUTING.md and README contributing sections at the root guide

Test plan

  • npm run ci passes locally
  • npm run docs:link-check passes
  • rg 0\.2\.0 on README / docs / CHANGELOG — only historical references remain (CHANGELOG ## [0.2.0], MIGRATION sections, deprecation-policy history)

Related Issues

Summary by CodeRabbit

  • Documentation

    • Updated setup, install, and run examples to reflect version 0.3.0.
    • Added a new contributor guide and simplified related docs to point to the canonical instructions.
    • Refreshed deprecation and changelog references for the latest release.
  • Chores

    • Added repository ownership guidance for key areas and default file coverage.

zho and others added 2 commits June 30, 2026 00:34
Update consumer-facing install and MCP config pins to match package.json
0.3.0, add root CONTRIBUTING.md for GitHub onboarding, and route reviews
via CODEOWNERS for critical paths.

Co-authored-by: Cursor <cursoragent@cursor.com>
@jonathanMLDev jonathanMLDev self-assigned this Jun 29, 2026
@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@jonathanMLDev, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 45 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4d2f456c-3e01-45a5-ac25-3e8d3b703408

📥 Commits

Reviewing files that changed from the base of the PR and between f8315a8 and c8e0e4d.

📒 Files selected for processing (7)
  • .github/CODEOWNERS
  • CHANGELOG.md
  • CONTRIBUTING.md
  • README.md
  • docs/CONTRIBUTING.md
  • docs/README.md
  • docs/deprecation-policy.md
📝 Walkthrough

Walkthrough

Adds .github/CODEOWNERS assigning two owners to all paths and key directories. Introduces a root CONTRIBUTING.md with full contributor guidance; condenses docs/CONTRIBUTING.md to a redirect. Bumps all user-facing version references from 0.2.0 to 0.3.0 in README.md, CHANGELOG.md, and docs/deprecation-policy.md.

Changes

v0.3.0 docs update: CODEOWNERS, CONTRIBUTING, version bumps

Layer / File(s) Summary
CODEOWNERS and root CONTRIBUTING.md
.github/CODEOWNERS, CONTRIBUTING.md
Adds CODEOWNERS assigning wpak-ai and jonathanMLDev as owners for all files, /src/, /src/alliance/, package.json, and .github/workflows/. Adds root CONTRIBUTING.md covering prerequisites, dev workflow, architecture overview, PR conventions, and code style.
docs/CONTRIBUTING.md redirect and deprecation-policy version pin
docs/CONTRIBUTING.md, docs/deprecation-policy.md
Replaces detailed docs/CONTRIBUTING.md content with a short redirect to the root file and links to supplement docs. Updates the deprecation-policy.md example pin from 0.2.0 to 0.3.0.
README and CHANGELOG version bumps to 0.3.0
README.md, CHANGELOG.md
Updates install commands (npm/yarn/pnpm), Claude Desktop config snippets, npx examples, deploy commands, contribution section, and documentation table to reference 0.3.0; updates CHANGELOG unreleased compare link to v0.3.0...HEAD.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested reviewers

  • wpak-ai

🐇 A new CODEOWNERS file appears,
With CONTRIBUTING docs wiped of fears!
From 0.2 to 0.3,
The README sings free—
Hop along, the changelog now clears! 🎉

🚥 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 reflects the docs onboarding and ownership changes.
Linked Issues check ✅ Passed The docs updates align with #181 and #182 by syncing v0.3.0 onboarding examples, adding CODEOWNERS, and introducing root contributor guidance.
Out of Scope Changes check ✅ Passed The PR stays within documentation and ownership/onboarding scope, with no unrelated code or 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

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@codecov

codecov Bot commented Jun 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@f8315a8). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #184   +/-   ##
=======================================
  Coverage        ?   87.88%           
=======================================
  Files           ?       41           
  Lines           ?     1758           
  Branches        ?      559           
=======================================
  Hits            ?     1545           
  Misses          ?      213           
  Partials        ?        0           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Single CONTRIBUTING.md at repo root; update docs index and deprecation-policy links.

Co-authored-by: Cursor <cursoragent@cursor.com>
@jonathanMLDev

Copy link
Copy Markdown
Collaborator Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown
✅ Action performed

Full review finished.

@AuraMindNest AuraMindNest requested a review from wpak-ai June 29, 2026 18:01
@wpak-ai wpak-ai merged commit fda0e7e into cppalliance:main Jun 29, 2026
12 checks passed
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.

Bus factor: add CODEOWNERS file README version sync: update install/config examples from v0.2.0 to v0.3.0

3 participants