- README.md: restructure Preview section into Static + Dev modes with feature comparison table; mention juice inlining and live reload - CONTRIBUTING.md: update Development Setup with Go/Node.js requirements, static vs dev preview workflows, Juice reference - AGENTS.md: add dev command to subcommand list, document tools/server/ directory, update Build Tool section - docs/CONTRIBUTING.*.md (5 languages): add dev server section, Node.js requirement, live reload description - docs/README.*.md (5 languages): add dev mode to Preview section - docs/images/README.md: update capture instructions for dev server Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
3.4 KiB
3.4 KiB
Участие в разработке — Gitea Mail Templates
Способы участия
Добавление нового стиля
- Создайте каркас через инструмент:
cd tools && go run . create <имя-стиля>— создаёт полную структуру директорий с файлами-заготовками.tmplдля всех 11 типов писем - Отредактируйте каждый
.tmplфайл вthemes/<имя-стиля>/с вашим уникальным дизайном - Перегенерируйте превью:
cd tools && go run . preview all(скрипт автоматически находит все темы вthemes/и динамически генерирует селектор тем) - Отправьте PR со скриншотами
Рекомендации по стилю
- Каждый стиль должен включать все 11 типов шаблонов
- Используйте только встроенные функции шаблонов Gitea
- Ключи перевода из официальных файлов локали Gitea (
mail.*) - Не используйте
.DisplayNameгде его нет в контексте (collaborator, transfer, release, workflow_run, assigned, default) - Дизайн для 600px email клиентов
- Тестируйте в Gmail, Outlook, Apple Mail
Баг-репорты
- Проверьте переменные Go в шаблонах
- Сверьте ключи перевода с локалью Gitea
- Убедитесь что
.DisplayNameне используется где не надо - Перегенерируйте превью:
cd tools && go run . preview all - Создайте issue с указанием стиля и типа письма
Настройка разработки
- Go 1.21+ для рендеринга шаблонов и CLI
- Node.js 18+ (опционально) для сервера разработки с Juice CSS
Локальный предпросмотр (статический)
- Сгенерируйте данные:
cd tools && go run . preview all - Откройте
preview/index.htmlв браузере — сервер не нужен
Статическая симуляция Gmail/Outlook приблизительна. Используйте dev-режим для точного рендеринга.
Сервер разработки (live reload + CSS инлайн)
cd tools && go run . dev
# → http://localhost:3456
При изменении .tmpl файлов автоматически пересобирает и обновляет браузер.
Интеграционное тестирование
Разверните на Gitea: Site Administration > Configuration > Mailer > Send Test Email
Соглашение о коммитах
style(<имя>):— изменения шаблонов стиляpreview:— инструменты предпросмотраtools:— Go-скрипт сборкиdocs:— документация и переводыfix:— исправленияproject:— README, LICENSE, мета-файлы
Лицензия
Участвуя, вы соглашаетесь с лицензией MIT.