Files
GiteaMailTemplates/docs/CONTRIBUTING.ja.md
T
KenanZhuandClaude Opus 4.8 0bf982ffb9 refactor(tools): modularize CLI with urfave/cli/v2, externalise template metadata
- Split monolithic build-preview.go into modular packages:
  tools.go (entry), cli/ (list/create/delete/preview commands),
  config/ (JSON loading), preview/ (rendering engine, funcs, locale)
- Extract all template metadata into data/templates_config.json
  as single source of truth — no hardcoded template data in Go
- Replace hand-rolled CLI parsing with github.com/urfave/cli/v2
- Add sensible defaults for --folder (../themes) and --config
  (./data/templates_config.json) — most commands now run bare
- Add type-coercing gt/lt/ge/le template funcs for JSON float64
- Fix AppUrl to gitea.com matching official template convention
- rendered.js now exports __REGISTRY__ and __PARAMS__ alongside
  __RENDERED__ — preview/index.html reads all from single source
- Cross-validate all 11 template data contexts against official
  Gitea source (services/mailer/*.go + templates/mail/*.tmpl)
- Update all docs (README, AGENTS, CONTRIBUTING, 5 languages)
  to reflect new CLI workflow with create scaffolding command

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-04 12:26:44 +08:00

2.1 KiB

コントリビューション — Gitea メールテンプレート

参加方法

新しいスタイルの追加

  1. ツールでスキャフォールド: cd tools && go run . create <style-name> — 全11種類のメールタイプ用のプレースホルダ .tmpl ファイルを含む完全なディレクトリ構造を作成します
  2. themes/<style-name>/ 内の各 .tmpl ファイルを独自デザインで編集
  3. プレビューを再生成: cd tools && go run . preview all(ビルドスクリプトが themes/ 以下の全テーマを自動検出し、テーマセレクターも自動生成されます)
  4. スクリーンショット付きで PR を提出

スタイルガイドライン

  • 各スタイルに 全11種類のテンプレート を含める
  • Gitea 組み込み関数のみ使用
  • 翻訳キーは Gitea 公式ロケール (mail.*) から
  • .DisplayName を使用しない (collaborator, transfer, release, workflow_run, assigned, default)
  • 600px 幅のメールクライアント向けにデザイン
  • Gmail, Outlook, Apple Mail でテスト

バグレポート

  1. Go 変数が正しいか確認
  2. 翻訳キーが Gitea ロケールと一致するか確認
  3. .DisplayName が誤用されていないか確認
  4. プレビューを再生成: cd tools && go run . preview all
  5. スタイル名とメールタイプを明記して issue を作成

開発セットアップ

ローカルプレビュー

  1. データを生成: cd tools && go run . preview all
  2. preview/index.html をブラウザで開く
  3. Modern, Gmail, Outlook, Raw source を切り替えて確認

結合テスト

Gitea にデプロイ: Site Administration > Configuration > Mailer > Send Test Email


コミット規約

  • style(<name>): — スタイルのテンプレート変更
  • preview: — プレビューツールの変更
  • tools: — Go ビルドスクリプトの変更
  • docs: — ドキュメントと翻訳
  • fix: — バグ修正
  • project: — README, LICENSE, メタファイル

ライセンス

貢献により、MIT ライセンスに同意したものとみなします。