Term list /glossary
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- rust
调研方向
Start by reading the glossary and documentation structure in the Rodio repository; the issue does not name specific files or tests. Identify terms for audio pipeline or tree steps, their relationships, and what consumes them, then add a glossary section that helps contributors use those terms consistently.
由索引模型根据 Issue 内容生成。
描述
Rodio has more contributors 🎉 and the maintenance team is growing stronger 🥳. Communication and documentation efforts are harder then they have to be because we do not have words for every concept in rodio.
My goal is to build a glossary (specialized term list) and make that part of the documentation. We could make the docs link to that glossary each time one of its specialized terms is used.
It seems most urgent to get some words around the audio... pipelines?:
let thing = Decoder::new("path").amplify().pausable()
what do we call each of these steps and how they relate to each-other?
Lets give the steps names so we can discuss this more easily:
let decoder = Decoder::new();
let amplified = decoder.amplify();
let pausable = amplified.pausable();
This is an audio pipeline, but it could also be an audio tree (if we introduce mix). I think we need a words for
- the thing that generates the samples on one end of the pipeline/tree. Maybe it should be called the generator?
- referring to an earlier or later step in the pipeline/tree. Concretely is pausable, which is applied after amplify, the parent of amplify or its child? Maybe some other word works? And what is called the other way round?
- things that these pipelines are fed to. When this pipeline is consumed by something, what do we call it? consumer? It could also be called a Sink as that word will be freed up once we deprecate the
Sinkstruct.
- 主要语言
- Rust
- 星标
- 2.5k
- 派生
- 338
- 平均合并
- 1 天 3 小时
- 30 天内合并 PR
- 1
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
RustAudio/rodio 的其他 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 74/100
-
难度 1/5 1 小时以内 新手友好度 73/100
-
难度 3/5 1-2 天 新手友好度 62/100
-
WavDecoder::size_hint underflows (u32 wrap, ~4.29e9) after EOF, causes multi-GB Vec::collect() allocation可能已有人在做 @marin-m 于 6 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 72/100
-
难度 4/5 3-5 天 新手友好度 45/100
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 77/100
yunfie-twitter/Palleria#474 ·
维护者通常 1 天内回复
-
good first issue help wanted
难度 2/5 1-3 小时 新手友好度 72/100
servo/rust-smallvec#827 ·
维护者通常 1 天内回复
-
bug tests
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复