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

Ship question-type screenshots as a release asset (and regenerate them)

Đang mở
  • Có gì không ổn?
#171 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
48/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript
Lĩnh vực
build-system, release

Hướng nghiên cứu

Start with uv run codegen --screenshots and the existing screenshots/<slug>/{limesurvey,xlsform}.png outputs, then inspect how cdl-survey-types-* and formtransform-fixtures-* release assets are generated. Add the versioned tarball and manifest.json, and implement the completeness check for registered entities and PNGs. Done means current-registry screenshots are regenerated, packaged as a release asset, and stale or missing files are detected without Docker.

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

Mô tả

screenshots/<slug>/{limesurvey,xlsform}.png render each registry type as a respondent sees it. Nothing consumes them yet, but the survey site wants exactly these: its fragetypen page has LimeSurvey and KoboToolbox tabs per example that currently say "Screenshot folgt" (CorrelAid/cdl-wp-eins, QuestionTypeBlock.astro). qwacback's examples are the registry fixtures (e.g. qwacback single_choice = registry/entities/select_one/fixtures/xlsform.json, pinned at v0.7.1), so the screenshots match them one to one.

Site-side proposal: CorrelAid/cdl-wp-eins#33.

State today

  • Last generated in the initial commit (2026-08-05). The registry has changed a lot since, up to v0.7.1.
  • range has no screenshots.
  • Not in the npm package or the release assets. The only way to get them is the repo tree on main, which isn't versioned.

Proposal

  1. Regenerate all screenshots against the current registry (uv run codegen --screenshots).
  2. Release asset formtransform-screenshots-<version>.tar.gz, next to cdl-survey-types-* and formtransform-fixtures-*, with a manifest.json: 
    {
  "version": "0.7.1",
  "types": {
    "select_one": {
      "limesurvey": { "file": "select_one/limesurvey.png", "width": 1930, "height": 758, "engine": "LimeSurvey", "theme": "fruity_twentythree" },
      "xlsform":    { "file": "select_one/xlsform.png",    "width": 1296, "height": 450, "engine": "Enketo" }
    }
  }
}
    Width/height let consumers reserve layout space. engine makes clear the XLSForm shot is Enketo (the engine behind KoboToolbox web forms), not the Kobo UI itself.
  3. Completeness check (in codegen or CI, cheap, no Docker): every registry entity (types, variants, composites) has both PNGs, and no PNG exists for a slug that isn't registered. That keeps them from going stale silently, the way range did.
  4. Optional: note the registry version a screenshot was rendered from in the manifest, so a consumer can warn when it's older than the entity.

Consumers (planned)

  • qwacback already pulls formtransform assets at its pinned version. It would unpack this tarball, serve /api/examples/{type}/limesurvey.png and /xlsform.png, and add limesurveySrc, koboSrc, dimensions and alt text to the example response. Example and screenshot then always come from the same registry version. Keyed by registry slug, which fits CorrelAid/qwacback#49.
  • cdl-wp-eins renders what qwacback returns (CorrelAid/cdl-wp-eins#33).
Ngôn ngữ chính
TypeScript
Star
0
Fork
0
Merge trung bình
4 phút
Pull request đã merge (30 ngày)
100

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 CorrelAid/formtransform

Tất cả issue của CorrelAid/formtransform

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.