docs: publish the sponsorship rule set (SPONSORS.md + README section) - #3910
Conversation
Two tiers: Main for model developers (banner slot above the table, first mention in the login/provider lines, picker priority) and Standard for relays/gateways (table row, built-in preset near the top of the picker marked as a sponsor, providers-page entry, preset maintenance and issue triage priority, no SLA). Pricing by inquiry, rising after 20,000 stars with early sponsors locked in. Contact via X, the Discord #sponsors channel, and the sponsorship mailbox. README gains the section directly under Quick start with an empty Main banner slot and an empty Standard table; sponsor rows land on their own branches. The seven translated READMEs get a one-line link so a sponsor change stays a single English edit. privacy:scan allows the published contact address only in SPONSORS.md and README.md; the same address anywhere else still fails, with a test proving both sides.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
✅ Deterministic PR hygiene checks passed. |
github-actions
Bot
added
the
documentation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Team Run ID: 📒 Files selected for processing (3)
Included review availability: Your plan provides up to 10 included reviews per hour; 8 remain after this review. 📝 WalkthroughWalkthroughAdds a two-tier sponsorship program, documents its rules and placement, links translated READMEs to the policy, packages the policy file, and restricts the sponsorship contact to approved files. ChangesSponsorship program
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This change publishes sponsorship terms and README notices, packages the policy document, and permits the published contact address only in the intended files. It does not alter runtime behavior, and no current merge-readiness risk remains. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 2 files. (3 skipped: 3 unsupported.)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
리뷰 · 우선순위 62 / 80이 PR은 코드 기능을 새로 넣는 게 아니라, 스폰서십 규칙을 공개 문서로 고정하는 작업이다. 지금 구체적으로는 세 덩어리다. 첫째, 루트에 현재 다만 문서로 "나중에 줄 것"을 약속한 부분과, 빈 HTML 표가 README에 보이는 부분, 그리고 번역본 한 줄의 위치가 언어마다 다른 점은 머지 전에 한 번 짚고 가는 편이 좋다. 규칙 공개 자체는 바로 가치가 있다. README.md (Sponsors 표) - SPONSORS.md (Main / Standard 혜택) - "built-in provider picker … marked as a sponsor", "priority ordering"을 약속하지만, 현재 SPONSORS.md (Main: README login/provider lines) - Main 배너·Standard 표는 readme/README.*.md - SPONSORS.md는 "Quick start 다음 섹션 앞"에 한 줄이라고 적었지만, 실제 삽입 위치는 언어마다 다르다. fr/tr은 Platforms 앞, ja/ko/ru는 프로바이더 추가 앞, zh-CN/zh-TW는 亮点/亮點 앞이다. 링크만 두는 전략은 맞고, 위치 통일은 필수는 아니다. 다만 문서 문장을 "영어 README와 같은 자리"가 아니라 "각 언어 Quick start(또는 그에 해당하는 블록) 직후"처럼 느슨하게 고치거나, 위치를 영어와 맞추면 나중에 헷갈림이 줄어든다. scripts/privacy-scan.ts / isAllowedEmail - allowlist가 파일명 용어 - 메인테이너의 판단이 필요한 지점
너의 추천 이 댓글은 grok-bot이 작성했습니다 |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9e2f5c8c75
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ### Sponsors | ||
|
|
||
| Sponsors keep the proxy maintained across every upstream protocol change. Two tiers, one | ||
| [rule set](./SPONSORS.md): **Main** is reserved for model developers and takes the banner |
There was a problem hiding this comment.
When users read the README from an installed npm package, this relative link points to a file that is not present: package.json explicitly ships README.md but does not include SPONSORS.md, and npm pack --dry-run --ignore-scripts confirms the latter is omitted. Add SPONSORS.md to the published files or use an absolute repository URL so package users can reach the advertised rule set.
Useful? React with 👍 / 👎.
…ommented until the first row, anchor Main first-mention slots Review follow-ups on #3910: the packaged README linked a file the tarball did not carry (package.json files now lists SPONSORS.md); the empty Standard table is a commented template with an absolute-URL logo placeholder so the README asset guard stays green; the two README lines a Main sponsor is promised first mention in carry a sponsors:main-first-mention comment; SPONSORS.md disambiguates provider sponsors from the maintainer-sponsored PR label and says the picker field lands with the first sponsor preset.
1 participant
Summary
Publishes the sponsorship rule set so a sponsor, a contributor, and a README visitor all read the same terms.
SPONSORS.md: two tiers. Main is reserved for organizations that train or host their own models and gets the single banner slot above the table, first mention in the README login/provider lines, and picker priority. Standard is for relays and gateways and gets a table row (logo ~150px + thanks line + ~80-word blurb published verbatim), a built-in preset near the top of the provider picker marked as a sponsor, a providers-page entry, and maintenance (preset fixed when a release breaks it, issues triaged first, no SLA). Pricing by inquiry, rising after 20,000 stars with early sponsors locked in. Contact via X, the Discord#sponsorschannel, and the sponsorship mailbox. A "what sponsors do not get" section keeps routing defaults, security review, and user data off the table.README.md: a### Sponsorsblock directly under Quick start (before the Docker Compose details) with an empty Main banner slot and an empty Standard table. Sponsor rows land on their own branches after their agreements are paid, so this PR carries rules only, no names.readme/README.*.md(7 locales): one linking line before the section that follows Quick start, so a sponsor change stays a single English edit.scripts/privacy-scan.ts: allows the published contact address only inSPONSORS.mdandREADME.md; the same address in any other file still fails.tests/ci-workflows/privacy-scan-meta-key.test.tsproves both sides against the realscanText.Verification
bun run privacy:scan— passedbun run typecheck— passedbun test tests/ci-workflows/privacy-scan-meta-key.test.ts tests/ci-workflows/repo-hygiene.test.ts tests/ci-workflows/docs-bun-source-requirement.test.ts— 21 pass, 0 fail--no-verify); CI on this head is the gate.discord.gg/JEaPEtkHwhverified against the Discord invite API: no expiry, lands in#welcomeof the OpenCodex server.Checklist
Summary by CodeRabbit
Documentation
Tests