Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Add TSDoc to the public API and publish an API reference

Abierto
  • ¿Algo no está bien?
#1,579 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
52/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
docker, node.js, typescript
Área
backend, documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
TypeScript
Estrellas
2.6k
Forks
274
Merge medio
1 d 14 h
PR fusionados (30 d)
44

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de testcontainers/testcontainers-node

Todos los issues de testcontainers/testcontainers-node

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.