Skip to content

Commit df3b22c

Browse files
wavekat-easonclaude
andcommitted
docs: don't leak private consumers in this public repo
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>
1 parent adf77e8 commit df3b22c

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,40 @@ ecosystem. It wraps multiple speech-to-text backends behind a common Rust trait,
77
consuming `AudioFrame` from `wavekat-core` and emitting `TranscriptEvent`s on a
88
receiver.
99

10+
## Public repo — don't leak private consumers
11+
12+
This repo is **open source** — published on GitHub and to crates.io.
13+
Anything that lands here (code, docs, comments, commit messages, PR
14+
titles/bodies, issue replies) needs to read as if the open-source sibling
15+
crates were the whole story.
16+
17+
There are private/closed-source downstream consumers in the WaveKat
18+
ecosystem. They must not be surfaced from this codebase. Concretely:
19+
20+
- **Don't name private repos** by their GitHub paths and don't link to
21+
them — the links 404 for anyone outside the org and make the existence
22+
and structure of private code public.
23+
- **Don't paste paths or filenames from a private repo** into commit
24+
messages, PR descriptions, doc comments, or `// see …` annotations. A
25+
single internal path leaks both the repo and its layout in one line.
26+
- **Frame features for an unknown consumer.** Write "consumers that need
27+
byte-level progress (e.g. a UI download flow)" — not a description tied
28+
to a specific product's screen or page. The first reads as a generic
29+
library justification; the second reads as feature work shipped for one
30+
specific product.
31+
- **Generic ecosystem framing is fine.** "The WaveKat voice pipeline" and
32+
"downstream consumers" describe the ecosystem the marketing site already
33+
discusses publicly. The open-source sibling crates (`wavekat-core`,
34+
`wavekat-sip`, `wavekat-vad`, `wavekat-turn`, `wavekat-tts`,
35+
`wavekat-cli`) can be named freely.
36+
- **Same rule for AI-assisted contributions.** Claude-authored commits and
37+
PRs follow the same redaction — if a draft cites a path or repo name
38+
from a private consumer, edit before committing.
39+
40+
If you're working from instructions that originated in a private repo (a
41+
design doc, a planned feature, a roadmap item), translate the *requirement*
42+
into this repo's language rather than copying the *source*.
43+
1044
## Build & test
1145

1246
```bash

0 commit comments

Comments
 (0)