docs(contributing): remove outdated step — themes are auto-discovered by build script

The build-preview.go now uses discoverThemes() to find all theme directories
under themes/ automatically. The manual step of adding themes to a slice is
no longer needed.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
KenanZhuandClaude Opus 4.8 committed 2026-06-03 20:36:50 +08:00
1 parent d9e6873f49
commit 77854ee0ed
6 files changed
+18 -24

No files matched your search

+3 -4
View File
@@ -11,10 +11,9 @@ Thanks for your interest in contributing! This project aims to provide a diverse
1. Create the style directory: `themes/<your-style-name>/` 1. Create the style directory: `themes/<your-style-name>/`
2. Copy the directory structure from an existing style 2. Copy the directory structure from an existing style
3. Implement all 11 `.tmpl` files with your unique visual design 3. Implement all 11 `.tmpl` files with your unique visual design
4. Add your theme to the `themes` slice in `tools/build-preview.go` 4. Regenerate preview data: `go run ./tools/build-preview.go` — the build script auto-discovers all theme directories under `themes/`
5. Regenerate preview data: `go run ./tools/build-preview.go` 5. Add your theme as an `<option>` in `<select id="sel-theme">` in `preview/index.html`
6. Add your theme as an `<option>` in `<select id="sel-theme">` in `preview/index.html` 6. Submit a PR with screenshots of rendered emails
7. Submit a PR with screenshots of rendered emails
### Style Guidelines ### Style Guidelines
+3 -4
View File
@@ -7,10 +7,9 @@
1. スタイルディレクトリを作成: `themes/<style-name>/` 1. スタイルディレクトリを作成: `themes/<style-name>/`
2. 既存スタイルからディレクトリ構造をコピー 2. 既存スタイルからディレクトリ構造をコピー
3. 11個の `.tmpl` ファイルを独自デザインで実装 3. 11個の `.tmpl` ファイルを独自デザインで実装
4. `tools/build-preview.go` の `themes` スライスに追加 4. プレビューを再生成: `go run ./tools/build-preview.go`(ビルドスクリプトが `themes/` 以下の全テーマを自動検出します)
5. プレビューを再生成: `go run ./tools/build-preview.go` 5. `preview/index.html` の `<select id="sel-theme">` に追加
6. `preview/index.html` の `<select id="sel-theme">` に追加 6. スクリーンショット付きで PR を提出
7. スクリーンショット付きで PR を提出
### スタイルガイドライン ### スタイルガイドライン
+3 -4
View File
@@ -7,10 +7,9 @@
1. 스타일 디렉토리 생성: `themes/<style-name>/` 1. 스타일 디렉토리 생성: `themes/<style-name>/`
2. 기존 스타일에서 디렉토리 구조 복사 2. 기존 스타일에서 디렉토리 구조 복사
3. 11개 `.tmpl` 파일을 고유한 디자인으로 구현 3. 11개 `.tmpl` 파일을 고유한 디자인으로 구현
4. `tools/build-preview.go`의 `themes` 슬라이스에 추가 4. 프리뷰 재생성: `go run ./tools/build-preview.go` (빌드 스크립트가 `themes/` 아래의 모든 테마 디렉토리를 자동으로 찾습니다)
5. 프리뷰 재생성: `go run ./tools/build-preview.go` 5. `preview/index.html`의 `<select id="sel-theme">`에 추가
6. `preview/index.html`의 `<select id="sel-theme">`에 추가 6. 스크린샷과 함께 PR 제출
7. 스크린샷과 함께 PR 제출
### 스타일 가이드라인 ### 스타일 가이드라인
+3 -4
View File
@@ -7,10 +7,9 @@
1. Создайте директорию стиля: `themes/<имя-стиля>/` 1. Создайте директорию стиля: `themes/<имя-стиля>/`
2. Скопируйте структуру из существующего стиля 2. Скопируйте структуру из существующего стиля
3. Реализуйте все 11 `.tmpl` файлов с уникальным дизайном 3. Реализуйте все 11 `.tmpl` файлов с уникальным дизайном
4. Добавьте тему в слайс `themes` в `tools/build-preview.go` 4. Перегенерируйте превью: `go run ./tools/build-preview.go` (скрипт автоматически находит все темы в `themes/`)
5. Перегенерируйте превью: `go run ./tools/build-preview.go` 5. Добавьте тему в `<select id="sel-theme">` в `preview/index.html`
6. Добавьте тему в `<select id="sel-theme">` в `preview/index.html` 6. Отправьте PR со скриншотами
7. Отправьте PR со скриншотами
### Рекомендации по стилю ### Рекомендации по стилю
+3 -4
View File
@@ -7,10 +7,9 @@
1. 创建风格目录:`themes/<风格名称>/` 1. 创建风格目录:`themes/<风格名称>/`
2. 从现有风格复制目录结构 2. 从现有风格复制目录结构
3. 用独特的视觉设计实现全部 11 个 `.tmpl` 文件 3. 用独特的视觉设计实现全部 11 个 `.tmpl` 文件
4. 在 `tools/build-preview.go` 的 `themes` 切片中添加新主题 4. 重新生成预览:`go run ./tools/build-preview.go`(构建脚本会自动发现 `themes/` 下的所有主题目录)
5. 重新生成预览:`go run ./tools/build-preview.go` 5. 在 `preview/index.html` 的 `<select id="sel-theme">` 中添加选项
6. 在 `preview/index.html` 的 `<select id="sel-theme">` 中添加选项 6. 提交包含截图渲染效果的 PR
7. 提交包含截图渲染效果的 PR
### 风格指南 ### 风格指南
+3 -4
View File
@@ -7,10 +7,9 @@
1. 建立風格目錄:`themes/<風格名稱>/` 1. 建立風格目錄:`themes/<風格名稱>/`
2. 從現有風格複製目錄結構 2. 從現有風格複製目錄結構
3. 以獨特的視覺設計實作全部 11 個 `.tmpl` 檔案 3. 以獨特的視覺設計實作全部 11 個 `.tmpl` 檔案
4. 在 `tools/build-preview.go` 的 `themes` 切片中新增主題 4. 重新產生預覽:`go run ./tools/build-preview.go`(建置腳本會自動發現 `themes/` 下的所有主題目錄)
5. 重新產生預覽:`go run ./tools/build-preview.go` 5. 在 `preview/index.html` 的 `<select id="sel-theme">` 中新增選項
6. 在 `preview/index.html` 的 `<select id="sel-theme">` 中新增選項 6. 提交包含螢幕截圖的 PR
7. 提交包含螢幕截圖的 PR
### 風格指南 ### 風格指南