Add TSDoc to the public API and publish an API reference
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 52/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- docker, node.js, typescript
- 领域
- backend, documentation
调研方向
Start with the exported classes and options in packages/testcontainers/src/test-container.ts, types.ts, and the other listed source files; check existing docs for defaults, units, and behavior before adding TSDoc. Then inspect mkdocs.yml and the Docs job in .github/workflows/checks.yml to find how generated references fit the publishing flow. Done means exported methods and option fields have useful TSDoc and the generated API reference is published with the docs site.
由索引模型根据 Issue 内容生成。
描述
What happens
The public API has almost no doc comments. An editor hover shows a signature and nothing else:
| File | Public methods | Doc comments |
|---|---|---|
test-container.ts (TestContainer, StartedTestContainer) |
57 | 0 |
generic-container.ts |
40 | 0 |
docker-compose-environment.ts |
13 | 0 |
http-wait-strategy.ts |
11 | 0 |
wait.ts |
7 | 0 |
generic-container-builder.ts |
7 | 0 |
network.ts |
4 | 0 |
Defaults, units and behaviour (stop() removes the container and its volumes by default, withBindMounts replaces, logs({ since }) is in seconds) are only on the docs site, where they are described per feature and not per method.
Expected
- A short TSDoc comment on every exported method and option field, covering what the code cannot say: the default, the unit, and any non-obvious behaviour.
- An API reference generated from those comments and published with the docs site.
Where
packages/testcontainers/src/test-container.ts,types.tsand the exported classesmkdocs.ymland theDocsjob in.github/workflows/checks.yml
Notes
- AGENTS.md asks for minimal code comments. This would be a deliberate exception for the exported API, limited to information a caller cannot get from the signature.
- Can be done one file at a time.
Dependencies
- Nothing blocks this. It can start now.
- Coordinate with #1542: the unit documentation there is a subset of this.
- 主要语言
- TypeScript
- 星标
- 2.6k
- 派生
- 274
- 平均合并
- 1 天 14 小时
- 30 天内合并 PR
- 44
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
testcontainers/testcontainers-node 的其他 Issue
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 74/100
testcontainers/testcontainers-node#1539 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 82/100
testcontainers/testcontainers-node#1533 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 77/100
testcontainers/testcontainers-node#1531 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 76/100
testcontainers/testcontainers-node#1529 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 78/100
testcontainers/testcontainers-node#1528 ·
维护者通常 1 天内回复
查看 testcontainers/testcontainers-node 的全部 Issue
相似的 Issue
-
难度 1/5 1-3 小时 新手友好度 70/100
siyuan-note/siyuan#20517 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 70/100
NaturalIntelligence/fast-xml-parser#890 · 1 条评论 ·
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 62/100
zsviczian/obsidian-excalidraw-plugin#3000 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
pnpm/get.pnpm.io#68 ·
-
难度 2/5 1-3 小时 新手友好度 72/100
nuxt-modules/better-auth#578 · 2 条评论 ·
维护者通常 1 天内回复