1 Fork 0

Files

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.0 KiB

Raw Blame History

貢獻指南 — Gitea 郵件模板

參與方式

新增風格

使用工具腳手架：cd tools && go run . create <風格名稱> — 這會建立完整的目錄結構和全部 11 種郵件類型的佔位 .tmpl 檔案
在 themes/<風格名稱>/ 中編寫每個 .tmpl 檔案，套用獨特的視覺設計
重新產生預覽：cd tools && go run . preview all（建置腳本會自動發現 themes/ 下的所有主題目錄並動態生成主題選擇器）
提交包含螢幕截圖的 PR

風格指南

每個風格必須包含全部 11 種模板類型
僅使用 Gitea 內建模板函式
翻譯鍵必須來自 Gitea 官方語系檔案（mail.* 命名空間）
請勿在以下模板中使用 .DisplayName：collaborator、transfer、release、workflow_run、assigned、default
針對 600px 寬度的郵件用戶端設計
盡可能在 Gmail、Outlook、Apple Mail 中測試

回報 Bug

檢查引用的 Go 模板變數是否存在
驗證翻譯鍵是否與 Gitea 語系檔案相符
確認 .DisplayName 未在不支援的模板中使用
重新產生預覽：cd tools && go run . preview all
提交 issue，註明風格名稱、郵件類型及錯誤描述

改善文件

文件改進、預覽螢幕截圖、安裝指南和翻譯始終歡迎。

開發環境

無需建置工具或依賴。

本機預覽

先生成預覽資料：cd tools && go run . preview all
在瀏覽器中開啟 preview/index.html
在 Modern、Gmail、Outlook、Raw source 模式間切換驗證效果

整合測試

將模板部署至 Gitea 實例，使用管理後台的測試郵件功能： Site Administration > Configuration > Mailer > Send Test Email

提交規範

style(<名稱>): — 特定風格的模板變更
preview: — 預覽工具變更
tools: — Go 建置腳本變更
docs: — 文件與翻譯
fix: — Bug 修復
project: — README、LICENSE、中繼資料檔案

授權條款

參與貢獻即表示您同意將您的貢獻以 MIT 授權條款授權。

2.0 KiB Raw Blame History Unescape Escape