Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン
  • 何か問題がありますか？
#171 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
48/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
typescript
領域
build-system, release

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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).
主要言語
TypeScript
スター
0
フォーク
0
平均マージ
4分
マージ済み PR（30日）
100

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

CorrelAid/formtransform のほかの issue

CorrelAid/formtransform の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。