Skip to content

docs: scrub downstream references + public-OSS no-downstream rule#3846

Merged
PierreBrisorgueil merged 1 commit into
masterfrom
docs/oss-no-downstream-refs
Jun 12, 2026
Merged

docs: scrub downstream references + public-OSS no-downstream rule#3846
PierreBrisorgueil merged 1 commit into
masterfrom
docs/oss-no-downstream-refs

Conversation

@PierreBrisorgueil

@PierreBrisorgueil PierreBrisorgueil commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

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

  • Documentation
    • Updated contributor guidelines to establish neutral, consistent language standards across all public-facing documentation, issue trackers, code comments, and team communications.
    • Refined migration documentation and deployment guides with improved clarity and standardized terminology for better readability.
    • Standardized internal documentation references to ensure consistency throughout migration procedures, upgrade notes, and related resources.

Copilot AI review requested due to automatic review settings June 12, 2026 13:18
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

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

Changes

Public OSS Reference Cleanup

Layer / File(s) Summary
Add public OSS guardrail policy
CLAUDE.md
New section documents the rule that contributors must not reference downstream consumers (e.g., project names, domains, infra details, business decisions, private tracker links) in code, comments, docs, issues, PRs, or commit messages, and must use neutral wording instead.
Remove downstream-specific references from migrations
MIGRATIONS.md, modules/organizations/migrations/20260610140000-backfill-membership-source.js
Referral rewards example comment generalized; membership consent split sequencing reference removed; org email-invite test-row note removed; invitations hardening handling reference removed; and migration deployment ordering instruction reworded to neutral language.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is missing several required template sections including Scope, Validation, Guardrails check, and Notes for reviewers. Add missing sections: Scope (modules impacted, cross-module impact, risk level), Validation (lint/test checklist), Guardrails check (secrets, renames, mergeability, tests), and Notes for reviewers.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main objectives: removing downstream references and adding the public-OSS guardrail rule to CLAUDE.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/oss-no-downstream-refs

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

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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

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.md to 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.

Comment thread MIGRATIONS.md
Comment thread MIGRATIONS.md
@codecov

codecov Bot commented Jun 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.96%. Comparing base (2219a82) to head (879ebe8).
⚠️ Report is 1 commits behind head on master.

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           
Flag Coverage Δ
integration 59.84% <ø> (ø)
unit 72.67% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2219a82...879ebe8. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2219a82 and 879ebe8.

📒 Files selected for processing (3)
  • CLAUDE.md
  • MIGRATIONS.md
  • modules/organizations/migrations/20260610140000-backfill-membership-source.js

Comment thread CLAUDE.md
@PierreBrisorgueil

Copy link
Copy Markdown
Contributor Author

@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).

@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

@PierreBrisorgueil: Understood — resolving all three. Two flagged references pointing to the public sister repo (not a downstream consumer) and the third suggested wording that was already present. Thanks for the clarification!


✏️ Learnings added
Learnt from: PierreBrisorgueil
URL: https://github.com/pierreb-devkit/Node/pull/3846

Timestamp: 2026-06-12T13:28:24.283Z
Learning: In the pierreb-devkit/Node repository, references to the public sister/companion OSS repo should NOT be flagged as "downstream consumer" references. Only private/internal project names, domains, infra/cluster details, business decisions, or private tracker links constitute downstream references under the repo's "no downstream references" rule (documented in CLAUDE.md).

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

✅ Action performed

Comments resolved and changes approved.

@PierreBrisorgueil PierreBrisorgueil merged commit 755af6e into master Jun 12, 2026
9 checks passed
@PierreBrisorgueil PierreBrisorgueil deleted the docs/oss-no-downstream-refs branch June 12, 2026 13:28
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