コンテンツにスキップ

コントリビューター向け

このセクションは、Timeline DSL 本体やこのドキュメントサイトを fork して開発する人、pull request を作成する人、公開設定を保守する人に向けた情報です。

.tdsl ファイルを作成・検証・レンダリングするだけの場合は、インストールQuick Start から読み進めてください。

このサイトは Astro + Starlight 製で、コマンドはすべて site/ 配下で実行します。パッケージマネージャは pnpm、Node.js は 24 を使います。

Terminal window
cd site
pnpm install --frozen-lockfile # 依存をインストール
pnpm dev # 開発サーバー(http://localhost:4321)

変更を push する前に、対応する smoke でリグレッションを確認します。

コマンド用途
pnpm buildsmoke:wasmastro checkastro build。CI が見る最低条件
pnpm smoke:wasmWASM バインディングの単体 smoke
pnpm smoke:playgroundPlayground の HTTP smoke
pnpm smoke:i18nja / en ペアと hreflang の整合
pnpm smoke:seotitle / meta / OGP / JSON-LD の検証

UI を変更したときは、ブラウザ smoke(pnpm smoke:playground:browser)もローカルで一度通してください(CI では走りません)。初回は pnpm exec playwright install chromium が必要です。

  • コミットは Conventional Commits 形式(feat: / fix: / docs: など)で書きます。
  • PR 本文に対応 issue を Closes #N で必ず紐付け、PR タイトルは 70 文字以内に収めます。
  • 変更が複数の責務に跨る場合は PR を分けます(1 PR = 1 論理的変更)。
  • main への force push は禁止です(CI 履歴と Cloudflare Pages のデプロイ履歴が壊れます)。
  • マージ前に Cloudflare Pages の preview デプロイが Green であることを確認します。
  • ja のドキュメントを編集したら、対応する en のページも同じ PR の中で更新します。日本語ページに英語タイトルを残さないでください。
  • 新しい色を直書きせず、site/src/styles/global.css--color-* トークンを使います。新色が必要な場合は light / dark / high-contrast の 3 セットを同時に追加します。