Skip to content

Commit ac2c4c0

Browse files
docs: clarify CODEOWNERS roles and CI gate scope
1 parent e5f1317 commit ac2c4c0

3 files changed

Lines changed: 24 additions & 15 deletions

File tree

.github/CODEOWNERS

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
# Code owners — auto-requested as reviewers on matching paths.
22
# Last match wins; see https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
33
#
4-
# Review expectation: PR authors wait for at least one CODEOWNERS approval before merge.
5-
# Do not self-merge without review, even on docs-only changes.
4+
# Roles:
5+
# Development + code review: @clean6378-max-it (Chen), @timon0305 (Zilin)
6+
# Final approval + merge: @wpak-ai (Will Pak)
7+
#
8+
# PR authors do not self-merge. Get a code review from Chen or Zilin, then final
9+
# approval from Will before merge.
610

7-
# Default owner for the repository.
8-
* @clean6378-max-it
11+
# Default owners for the repository.
12+
* @clean6378-max-it @timon0305 @wpak-ai
913

1014
# Docs and contributor process
11-
/docs/ @clean6378-max-it
12-
/CONTRIBUTING.md @clean6378-max-it
13-
/README.md @clean6378-max-it
15+
/docs/ @clean6378-max-it @timon0305 @wpak-ai
16+
/CONTRIBUTING.md @clean6378-max-it @timon0305 @wpak-ai
17+
/README.md @clean6378-max-it @timon0305 @wpak-ai
1418

1519
# CI and workflow changes
16-
/.github/ @clean6378-max-it
20+
/.github/ @clean6378-max-it @timon0305 @wpak-ai

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ claude-code-chat-browser/
145145

146146
See **[`CONTRIBUTING.md`](CONTRIBUTING.md)** for full setup, conventions, and where to change each layer. New contributors should follow **[`docs/onboarding.md`](docs/onboarding.md)** for a first-PR walkthrough and reading order.
147147

148-
**Maintainer coverage:** commit activity is currently concentrated on a small set of identities (bus-factor risk). Mitigations: [`.github/CODEOWNERS`](.github/CODEOWNERS) for review routing and [`docs/onboarding.md`](docs/onboarding.md) so additional contributors can ramp quickly.
148+
**Maintainer coverage:** commit activity is currently concentrated on a small set of identities (bus-factor risk). Mitigations: [`.github/CODEOWNERS`](.github/CODEOWNERS) splits development/code review (@clean6378-max-it, @timon0305) from final approval and merge (@wpak-ai), plus [`docs/onboarding.md`](docs/onboarding.md) for contributor ramp-up.
149149

150150
Quick start:
151151

docs/onboarding.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,14 @@ python app.py --port 5000
6262

6363
### 5. Run the full local gate
6464

65-
CI runs these on Ubuntu, Windows, and macOS. Run them locally before opening a PR:
65+
Run these locally before opening a PR. In CI, **ruff** (`check` + `format --check`) runs on Ubuntu, Windows, and macOS. **mypy** runs only in the Ubuntu job; run it locally before Python-heavy changes. **pip-audit**, **pytest**, integration tests, and **Vitest** also run on all three platforms in CI.
6666

6767
```bash
68-
# Lint + format (required)
68+
# Lint + format (CI: Ubuntu + Windows + macOS)
6969
ruff check .
7070
ruff format --check .
7171

72-
# Type check (Ubuntu CI job; run locally before Python-heavy changes)
72+
# Type check (CI: Ubuntu only)
7373
mypy -p api -p utils -p models -p scripts
7474

7575
# Security audit (production deps)
@@ -102,7 +102,12 @@ Open a pull request against **`master`** on `cppalliance/claude-code-chat-browse
102102

103103
### 7. Review
104104

105-
[`.github/CODEOWNERS`](../.github/CODEOWNERS) auto-requests reviewers on new PRs. **Do not self-merge** — wait for at least one approval. Address review feedback in follow-up commits on the same branch.
105+
[`.github/CODEOWNERS`](../.github/CODEOWNERS) auto-requests reviewers on new PRs. **Do not self-merge.**
106+
107+
1. **Code review** from @clean6378-max-it (Chen) or @timon0305 (Zilin). They own development and technical review on this repo.
108+
2. **Final approval and merge** from @wpak-ai (Will Pak) after code review is done.
109+
110+
Address review feedback in follow-up commits on the same branch.
106111

107112
## Good first issues
108113

@@ -120,7 +125,7 @@ Recent commit history is concentrated on a small set of identities. If those mai
120125

121126
**Mitigations in this repo:**
122127

123-
- **[`.github/CODEOWNERS`](../.github/CODEOWNERS)**routes review requests so PRs do not rely on ad-hoc pings.
124-
- **This onboarding path** — lowers the ramp for a second reviewer or contributor to run gates and ship safely.
128+
- **[`.github/CODEOWNERS`](../.github/CODEOWNERS)**@clean6378-max-it and @timon0305 for development and code review; @wpak-ai for final approval and merge.
129+
- **This onboarding path** — lowers the ramp for additional contributors to run gates and ship safely.
125130

126131
If you are joining as a reviewer, read the [suggested reading order](#suggested-reading-order) and run the [full local gate](#5-run-the-full-local-gate) once on `master` before approving your first PR.

0 commit comments

Comments
 (0)