docs: don't leak private consumers in this public repo - #11
Merged
Conversation
Adds explicit guidance to CLAUDE.md (so future AI-assisted contributions
inherit it) that wavekat-asr is open source and has private/closed-source
downstream consumers in the WaveKat ecosystem. Commit messages, PR bodies,
doc comments, and `// see ...` annotations in this repo must not name
private repos by their GitHub paths, link to them, or paste their internal
file paths. Frame features for an unknown consumer instead.
Generic ecosystem framing ("the WaveKat voice pipeline," "downstream
consumers") and the other open-source sibling crates are fine to name.
Only the private repos need redaction.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
wavekat-eason
force-pushed
the
docs/private-consumer-guidance
branch
from
May 16, 2026 23:18
af8dc1b to
df3b22c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds explicit guidance to
CLAUDE.mdso future contributions (Claude-authored or otherwise) inherit it: this repo is open source, it has private/closed-source downstream consumers in the WaveKat ecosystem, and cross-references to those private repos need redaction in code, docs, commit messages, and PR text.Why
There was a real gap — an earlier PR in this repo included identifying details about a private downstream consumer in its description and commit body. The links 404 for anyone outside the org, but the existence and internal layout of the private code became public. Codifying the rule in CLAUDE.md prevents the same leak from sneaking into future commits.
What's in scope
// see ...annotationswavekat-core,wavekat-sip, etc.)Test plan
cargo fmt --checkandcargo doc --no-deps -p wavekat-asr --all-featuresstill pass (unchanged from main).Follow-up
The earlier PR still has leaks in its description and commit body. Once this lands I'll send a follow-up to redact those.
🤖 Generated with Claude Code