Skip to content

chore: add CODEOWNERS to auto-request reviews#4

Open
JacobPEvans-personal wants to merge 2 commits into
mainfrom
chore/add-codeowners
Open

chore: add CODEOWNERS to auto-request reviews#4
JacobPEvans-personal wants to merge 2 commits into
mainfrom
chore/add-codeowners

Conversation

@JacobPEvans-personal

Copy link
Copy Markdown
Contributor

What is CODEOWNERS?

CODEOWNERS is a GitHub-native file (here at .github/CODEOWNERS) that maps
path patterns → owners. When a pull request changes a file, GitHub looks up
who owns that path and automatically adds them as a requested reviewer. If
the repo later turns on the branch-protection rule "Require review from Code
Owners"
, those owners' approval also becomes required before merge.

How it works

  • One rule per line: <path-pattern> <owner> [<owner> ...].
  • Owners are GitHub usernames (@user) or teams (@org/team), and must have
    write access
    to the repo or GitHub ignores them. (@werd-drew has admin
    access here, so he qualifies.)
  • Last match wins. The catch-all * is listed first so it's the weakest
    rule; every more specific rule below it overrides the default for its paths.
  • It lives on the default branch (main) to take effect — which is exactly
    what this PR does.

Why use it

  • No more guessing who should review — the right person is requested
    automatically, every time, based on what changed.
  • It's living documentation of who is responsible for each part of the codebase.
  • It scales: ownership can be made more granular per area as the team grows.

What this PR does

Adds .github/CODEOWNERS with @werd-drew as the owner of all code currently
on main. Instead of a single blanket * @werd-drew, the file is broken into
meaningful areas
:

Area Path
Default (catch-all) *
API client / transports / endpoint factory /cribl_cli/api/
CLI commands + registry /cribl_cli/commands/
Auth /cribl_cli/auth/
Config loading /cribl_cli/config/
Output formatting /cribl_cli/output/
Shared utilities /cribl_cli/utils/
CLI wiring /cribl_cli/cli.py
Entry point /bin/
Packaging /pyproject.toml
Tests /tests/
Search dashboards /dashboards/
Docs /README.md, /CLAUDE.md, /docs/
Repo automation /.github/

Everyone is @werd-drew today. The split exists so a second reviewer can be
added to just one area later
— e.g. change /cribl_cli/api/ to
@werd-drew @someone-else — without affecting the rest.

Test Plan

  • Validated against GitHub's CODEOWNERS API: GET /repos/.../codeowners/errors
    returns {"errors":[]} (no syntax or unknown-owner errors).
  • No code changes; this is repo governance only.

Optional follow-up (not in this PR)

To make code-owner review required (not just auto-requested), enable
Settings → Branches → main → Require review from Code Owners. Left off for now
so it doesn't block these in-flight PRs.

🤖 Generated with Claude Code

Add .github/CODEOWNERS so GitHub automatically requests a review from the
responsible maintainer whenever a pull request touches code they own.

@werd-drew is set as the owner of every area. Rather than a single `*` line,
the file is split by area (api, commands, auth, config, output, utils, tests,
dashboards, docs, packaging, repo automation) so a second reviewer can later be
added to just one area without touching the rest. A catch-all `*` rule keeps
everything owned by default; the more specific rules override it (last match
wins).

Copilot AI 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.

Pull request overview

Adds a GitHub CODEOWNERS file to automatically request reviews from the designated owner(s) based on which paths change in a PR, providing a foundation for future “Require review from Code Owners” branch protection.

Changes:

  • Introduces .github/CODEOWNERS with a catch-all rule and more specific path-based ownership rules.
  • Splits ownership by meaningful codebase areas (API, commands, auth, config, output, utilities, docs, tests, automation) while currently assigning a single owner to all paths.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@JacobPEvans-personal
JacobPEvans-personal marked this pull request as ready for review June 21, 2026 21:46
@JacobPEvans-personal
JacobPEvans-personal marked this pull request as draft June 21, 2026 21:52
@JacobPEvans-personal
JacobPEvans-personal marked this pull request as ready for review June 21, 2026 22:20
Co-owns the application code that can change backend API endpoints or CLI
behavior (everything under /cribl_cli/ plus the /bin/ entry point) so reviews
are auto-requested on the part integrated with X10.
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.

2 participants