Add CONTRIBUTING, CHANGELOG, and CODEOWNERS; centralize yq onboarding (closes #71)#75
Conversation
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 11 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the 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. 📝 WalkthroughWalkthroughThis PR adds repository governance documentation: a CODEOWNERS file assigning default reviewers, a CHANGELOG.md following Keep a Changelog format with Unreleased and 0.1.0 entries, a CONTRIBUTING.md covering dev setup/testing/linting/PR process, and README links to both new documents. ChangesGovernance documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
16-20: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winTrim the yq guidance to a single pointer.
This repeats the README's yq disambiguation, which makes the onboarding docs drift from the single-source-of-truth goal in the PR. Keep the local guide to a short prerequisite note and defer the tool comparison/details to the README.
♻️ Proposed simplification
-### yq (read this first) - -Several incompatible tools share the name `yq`. Local CI requires mikefarah/yq v4+ — not the PyPI `yq` package and not kislyuk/yq. Installing the wrong tool causes unclear runtime failures. - -→ Full disambiguation table and per-OS install commands: README yq section +### yq + +Install mikefarah/yq v4+; see the README yq section for the full disambiguation table and per-OS install commands.🤖 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 `@CONTRIBUTING.md` around lines 16 - 20, The yq guidance in CONTRIBUTING should be shortened to a single prerequisite pointer instead of repeating the full disambiguation from README. Update the yq section to keep only a brief note that local CI requires mikefarah/yq v4+ and direct readers to the existing README anchor for install details, preserving the unique symbols “yq (read this first)” and the README link target so the onboarding docs stay aligned with the single source of truth.
🤖 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 `@CONTRIBUTING.md`:
- Around line 16-20: The yq guidance in CONTRIBUTING should be shortened to a
single prerequisite pointer instead of repeating the full disambiguation from
README. Update the yq section to keep only a brief note that local CI requires
mikefarah/yq v4+ and direct readers to the existing README anchor for install
details, preserving the unique symbols “yq (read this first)” and the README
link target so the onboarding docs stay aligned with the single source of truth.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: ca116a1d-eeeb-4b8f-a395-0f83a3645058
📒 Files selected for processing (4)
.github/CODEOWNERSCHANGELOG.mdCONTRIBUTING.mdREADME.md
Summary
Adds contributor governance docs for the pre-release
0.1.0project and surfaces the mikefarah/yq v4+ prerequisite in the onboarding path without duplicating the README disambiguation table.CONTRIBUTING.md— dev setup (pip install -e ".[dev]"), unit vs integration tests, ruff/mypy, pre-commit, and PR expectationsCHANGELOG.md— Keep a Changelog format with[Unreleased],0.1.0baseline, and pre-1.0 stability notes.github/CODEOWNERS— routes reviews to@bradjin8README.md— Documentation section links to the new filesCloses #71.
Acceptance criteria
CONTRIBUTING.mdcovers dev setup, tests (pytest+integrationmarker), lint/typing (ruff,mypy localci/), pre-commit, and PR/review expectationsCONTRIBUTING.mdlinks to README yq disambiguation (does not duplicate it)CHANGELOG.mdwith[Unreleased]+0.1.0baseline and pre-release stability noteREADME.mdcross-linksCONTRIBUTING.mdandCHANGELOG.mdCODEOWNERSnames current maintainerpre-commit run -a)Test plan
pre-commit run -a— all hooks greenSummary by CodeRabbit