Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Add TSDoc to the public API and publish an API reference

Đang mở
  • Có gì không ổn?
#1,579 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
52/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
docker, node.js, typescript
Lĩnh vực
backend, documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
TypeScript
Star
2.6k
Fork
274
Merge trung bình
1 ngày 14 giờ
Pull request đã merge (30 ngày)
44

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của testcontainers/testcontainers-node

Tất cả issue của testcontainers/testcontainers-node

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.