Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Add TSDoc to the public API and publish an API reference

Aperta
  • Qualcosa non va?
#1,579 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
52/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
docker, node.js, typescript
Ambito
backend, documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

maintenance patch

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.ts and the exported classes
  • mkdocs.yml and the Docs job 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.
Lingua principale
TypeScript
Stelle
2.6k
Fork
274
Merge medio
1g 14h
PR unite (30g)
44

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di testcontainers/testcontainers-node

Tutte le issue di testcontainers/testcontainers-node

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.