86 lines
2.9 KiB
Markdown
86 lines
2.9 KiB
Markdown
# 贡献指南 — Gitea 邮件模板
|
||
|
||
## 参与方式
|
||
|
||
### 添加新风格
|
||
|
||
1. 使用工具脚手架：`cd tools && go run . create <风格名称>` — 这会创建完整的目录结构和全部 11 种邮件类型的占位 `.tmpl` 文件
|
||
2. 在 `themes/<风格名称>/` 中编写每个 `.tmpl` 文件，应用独特的视觉设计
|
||
3. 重新生成预览：`cd tools && go run . preview all`（构建脚本会自动发现 `themes/` 下的所有主题目录并动态生成主题选择器）
|
||
4. 提交包含截图渲染效果的 PR（单张图片 ≤ 50 KiB，建议 10–20 KiB）
|
||
|
||
### 风格指南
|
||
|
||
- 每个风格必须包含全部 **11 种模板类型**
|
||
- 只使用 Gitea 内置模板函数
|
||
- 翻译键必须来自 Gitea 官方语言文件（`mail.*` 命名空间）
|
||
- **不要在以下模板中使用 `.DisplayName`**：collaborator、transfer、release、workflow_run、assigned、default
|
||
- 面向 600px 宽度的邮件客户端设计
|
||
- 尽可能在 Gmail、Outlook、Apple Mail 中测试
|
||
|
||
### 报告 Bug
|
||
|
||
1. 检查引用的 Go 模板变量是否存在
|
||
2. 验证翻译键是否与 Gitea 语言文件匹配
|
||
3. 确认 `.DisplayName` 未在不支持的模板中使用
|
||
4. 重新生成预览：`cd tools && go run . preview all`
|
||
5. 提交 issue，注明风格名称、邮件类型及错误描述
|
||
|
||
### 改进文档
|
||
|
||
文档改进、预览截图、安装指南和翻译始终欢迎。
|
||
|
||
---
|
||
|
||
## 开发环境
|
||
|
||
- **Go 1.21+** 用于模板渲染和 CLI 工具
|
||
- **Node.js 18+**（可选）用于实时开发服务器与 Juice CSS 内联
|
||
|
||
### 本地预览（静态）
|
||
|
||
1. 先生成预览数据：`cd tools && go run . preview all`
|
||
2. 在浏览器中打开 `preview/index.html` — 无需服务器
|
||
|
||
> [!WARNING]
|
||
> 静态 Gmail/Outlook 模拟仅供参考，使用 dev 模式可获得相对准确的 CSS 内联渲染。
|
||
|
||
### 开发服务器（实时重载 + CSS 内联 + 客户端模拟）
|
||
|
||
```bash
|
||
cd tools && go run . dev
|
||
# → http://localhost:3456
|
||
```
|
||
|
||
修改 `.tmpl` 文件后自动重建并推送至浏览器。
|
||
|
||
> [!NOTE]
|
||
> Dev 模拟无法 100% 还原各个邮件客户端的渲染差异，仅供参考，请以实际效果为准。
|
||
|
||
### 集成测试
|
||
|
||
将模板部署到 Gitea 实例后，请通过真实的邮件通知进行验证。管理后台的测试邮件
|
||
（**Site Administration > Configuration > Mailer > Send Test Email**）不会使用
|
||
自定义邮件模板——它走的是内置代码路径。
|
||
|
||
最可靠的验证方式是触发一次真实的邮件通知，推荐使用密码重置流程：
|
||
|
||
1. 退出登录，点击登录页的**"忘记密码"**
|
||
2. 输入账户邮箱并提交
|
||
3. 查看密码重置邮件——它将使用你的自定义邮件模板渲染
|
||
|
||
---
|
||
|
||
## 提交规范
|
||
|
||
- `style(<名称>):` — 特定风格的模板变更
|
||
- `preview:` — 预览工具变更
|
||
- `tools:` — Go 构建脚本变更
|
||
- `docs:` — 文档和翻译
|
||
- `fix:` — Bug 修复
|
||
- `project:` — README、LICENSE、元文件
|
||
|
||
## 许可协议
|
||
|
||
参与贡献即表示您同意将您的贡献以 MIT 许可证授权。
|