Skip to content

Add CONTRIBUTING, CHANGELOG, and CODEOWNERS; centralize yq onboarding (closes #71)#75

Merged
wpak-ai merged 2 commits into
developfrom
docs/contributing-changelog
Jul 9, 2026
Merged

Add CONTRIBUTING, CHANGELOG, and CODEOWNERS; centralize yq onboarding (closes #71)#75
wpak-ai merged 2 commits into
developfrom
docs/contributing-changelog

Conversation

@bradjin8

@bradjin8 bradjin8 commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds contributor governance docs for the pre-release 0.1.0 project 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 expectations
  • CHANGELOG.md — Keep a Changelog format with [Unreleased], 0.1.0 baseline, and pre-1.0 stability notes
  • .github/CODEOWNERS — routes reviews to @bradjin8
  • README.md — Documentation section links to the new files

Closes #71.

Acceptance criteria

  • CONTRIBUTING.md covers dev setup, tests (pytest + integration marker), lint/typing (ruff, mypy localci/), pre-commit, and PR/review expectations
  • CONTRIBUTING.md links to README yq disambiguation (does not duplicate it)
  • CHANGELOG.md with [Unreleased] + 0.1.0 baseline and pre-release stability note
  • README.md cross-links CONTRIBUTING.md and CHANGELOG.md
  • CODEOWNERS names current maintainer
  • Pre-commit passes locally (pre-commit run -a)

Test plan

  • pre-commit run -a — all hooks green
  • CI lint, typecheck, unit, and integration jobs pass on PR
  • Spot-check README Documentation links render correctly on GitHub

Summary by CodeRabbit

  • Documentation
    • Added a contributor guide with setup, testing, linting, and pull request expectations.
    • Added a changelog with an initial release history and unreleased notes.
    • Updated the main documentation list to include links to the new contributor and changelog pages.
  • Chores
    • Added default reviewer ownership for repository changes.

@bradjin8 bradjin8 self-assigned this Jul 9, 2026
@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 11 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: e955b585-414e-466f-b9ce-efe63d787c4b

📥 Commits

Reviewing files that changed from the base of the PR and between 1566a1e and 6744850.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
📝 Walkthrough

Walkthrough

This 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.

Changes

Governance documentation

Layer / File(s) Summary
Default code ownership
.github/CODEOWNERS
Adds a catch-all rule assigning @bradjin8 and @wpak-ai as default reviewers for all paths.
Changelog document
CHANGELOG.md
Adds a Keep a Changelog-formatted file with title/intro, an Unreleased section listing new docs and tooling, a 0.1.0 TBD baseline entry with pre-release stability notes, and reference links.
Contributing guide
CONTRIBUTING.md
Adds onboarding docs covering prerequisites (including yq v4+ disambiguation), dev setup, unit/integration test commands, linting/type-checking, pre-commit usage, PR process expectations, and maintainer/CODEOWNERS references.
README documentation links
README.md
Adds Contributing and Changelog bullets to the Documentation section, shifting existing entries down.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 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 clearly summarizes the main docs and ownership changes, including CONTRIBUTING, CHANGELOG, CODEOWNERS, and yq onboarding.
Linked Issues check ✅ Passed The PR matches #71 by adding CONTRIBUTING.md, CHANGELOG.md, README links, and optional CODEOWNERS, with yq surfaced via the onboarding path.
Out of Scope Changes check ✅ Passed The changes stay within the documentation and governance scope requested by the issue, with no unrelated code or behavioral 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/contributing-changelog

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.

🧹 Nitpick comments (1)
CONTRIBUTING.md (1)

16-20: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Trim 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

📥 Commits

Reviewing files that changed from the base of the PR and between b95310f and 1566a1e.

📒 Files selected for processing (4)
  • .github/CODEOWNERS
  • CHANGELOG.md
  • CONTRIBUTING.md
  • README.md

@henry0816191 henry0816191 requested a review from wpak-ai July 9, 2026 20:55
@bradjin8 bradjin8 requested review from wpak-ai and removed request for wpak-ai July 9, 2026 20:55
@wpak-ai wpak-ai merged commit a592402 into develop Jul 9, 2026
7 checks passed
@wpak-ai wpak-ai deleted the docs/contributing-changelog branch July 9, 2026 21:11
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.

Add CONTRIBUTING + CHANGELOG governance docs and centralize yq onboarding

3 participants