docs: scrub downstream references + public-OSS no-downstream rule#3846
Conversation
WalkthroughThis PR establishes and enforces a public OSS repository guardrail by removing internal project references from documentation. CLAUDE.md introduces rules forbidding downstream-specific wording, while MIGRATIONS.md and a migration file comment are cleaned up to remove Trawl-specific language, replacing it with generic or neutral phrasing. ChangesPublic OSS Reference Cleanup
🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint install failed due to a network error. 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 |
There was a problem hiding this comment.
Pull request overview
Updates documentation/comments to enforce a public-OSS constraint: this repo must not mention downstream consumers or their private details, and recent downstream-specific references introduced during the invitations epic are scrubbed.
Changes:
- Replaces a downstream-specific migration sequencing note with neutral wording in the membership-source backfill migration comment.
- Scrubs downstream-specific wording in
MIGRATIONS.md(e.g., “X-decided values”, explicit downstream sequencing references). - Adds an explicit “no downstream references” rule to
CLAUDE.mdto prevent future reintroduction.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| modules/organizations/migrations/20260610140000-backfill-membership-source.js | Rewords a migration header comment to remove a specific downstream/environment reference. |
| MIGRATIONS.md | Rewords a few downstream-facing notes to be more neutral; still contains a couple of downstream tracker references (flagged in review comments). |
| CLAUDE.md | Adds a repository-wide rule banning downstream consumer references in any repo artifacts. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3846 +/- ##
=======================================
Coverage 91.96% 91.96%
=======================================
Files 160 160
Lines 5289 5289
Branches 1698 1698
=======================================
Hits 4864 4864
Misses 337 337
Partials 88 88
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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.
Inline comments:
In `@CLAUDE.md`:
- Around line 5-7: Update the wording under the "## 🔓 PUBLIC OSS repo — no
downstream references" heading in CLAUDE.md (and mirror the same neutral pattern
in MIGRATIONS.md and the migration note) to remove any consumer-specific
phrases; replace instances like "downstream consumer", project names, domains,
cluster/infra details, or references to specific business decisions with a
standard neutral template such as "a downstream consumer", "the first consumer",
or "downstream rollouts", and ensure any examples or notes use non-identifying
placeholders and the same neutral guardrail language used elsewhere in the repo.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 5095ef44-5b5b-48f6-8f45-0ab77c7abbb3
📒 Files selected for processing (3)
CLAUDE.mdMIGRATIONS.mdmodules/organizations/migrations/20260610140000-backfill-membership-source.js
|
@coderabbitai resolve — the 3 findings are addressed above (2 misidentify the public sister repo as a downstream; 1 suggests the neutral wording already in place). |
|
✏️ Learnings added
✅ Action performedComments resolved and changes approved. |
This is a public OSS repo — it must never reference its downstream consumers (names, domains, infra, business decisions, private-tracker links). This PR: (1) neutralizes the recent mentions introduced by the invitations epic (MIGRATIONS entries + one migration comment), (2) adds the hard rule to CLAUDE.md so agents and contributors enforce it going forward. Historical mentions elsewhere are tracked in a follow-up issue. Docs/comments only.
Summary by CodeRabbit