universal-dev-standards 5.17.0 → 6.1.0

package/bundled/locales/zh-TW/options/changelog/auto-generated.md

@@ -0,0 +1,166 @@
+---
+source: options/changelog/auto-generated.md
+source_version: 1.0.0
+translation_version: 1.0.0
+status: current
+---
+
+# 自動產生的 Changelog
+
+> **語言**: [English](../../../../options/changelog/auto-generated.md) | 繁體中文
+
+**上層標準**: [Changelog Standards](../../core/changelog-standards.md)
+
+---
+
+## 概觀
+
+自動產生的 changelog 是使用解析 Conventional Commits 的工具，從 commit 歷史自動建立而來。此做法可減少人工作業，並確保 commit 與 changelog 條目之間的一致性。
+
+## 最適用於
+
+- 使用 Conventional Commits 的專案
+- CI/CD 自動化發行
+- 頻繁的發行週期
+- 偏好自動化而非手動編輯的團隊
+- 含多個套件的 Monorepo
+
+## 先決條件
+
+- 所有 commit 均採用 Conventional Commits 格式
+- 一致的 commit message 結構
+- CI/CD pipeline 整合
+
+## 工具
+
+| 工具 | 平台 | 命令 | 設定檔 |
+|------|----------|---------|-------------|
+| **conventional-changelog** | Node.js | `npx conventional-changelog -p angular -i CHANGELOG.md -s` | `.changelogrc` |
+| **semantic-release** | Node.js | `npx semantic-release` | `.releaserc` |
+| **git-cliff** | Rust | `git cliff -o CHANGELOG.md` | `cliff.toml` |
+| **release-please** | GitHub Action | GitHub workflow | `release-please-config.json` |
+
+## Commit 對應 Changelog
+
+| Commit 類型 | Changelog 區段 |
+|-------------|-------------------|
+| `feat` | Added |
+| `fix` | Fixed |
+| `perf` | Changed |
+| `refactor` | Changed |
+| `docs` | Documentation |
+| `chore` | Maintenance |
+| `BREAKING CHANGE` | Breaking Changes |
+
+## 設定範例
+
+### conventional-changelog
+
+```json
+// .changelogrc
+{
+  "preset": "angular",
+  "releaseCount": 0
+}
+```
+
+### git-cliff
+
+```toml
+# cliff.toml
+[changelog]
+header = "# Changelog\n\n"
+body = """
+{% for group, commits in commits | group_by(attribute="group") %}
+### {{ group | upper_first }}
+{% for commit in commits %}
+- {{ commit.message | upper_first }}
+{%- endfor %}
+{% endfor %}
+"""
+```
+
+### semantic-release
+
+```json
+// .releaserc
+{
+  "branches": ["main"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/npm",
+    "@semantic-release/git"
+  ]
+}
+```
+
+## 規則
+
+| 規則 | 描述 | 優先級 |
+|------|-------------|----------|
+| 使用 Conventional Commits | 將 commit 格式化以便正確解析 | Required |
+| 使用 scope 進行分組 | scope 有助於將相關變更分組 | Recommended |
+| BREAKING CHANGE footer | 為重大變更加上 footer | Required |
+| 設定 CI/CD | 自動化 changelog 產生 | Recommended |
+
+## 與手動方式的比較
+
+| 面向 | 自動產生 | 手動（Keep a Changelog） |
+|--------|---------------|---------------------------|
+| 工作量 | 低（自動化） | 高（人工撰寫） |
+| 一致性 | 高（以範本為基礎） | 不一（人工撰寫） |
+| 詳細程度 | Commit 層級 | 功能層級（經整理） |
+| 先決條件 | Conventional Commits | 無 |
+| 最適用於 | 頻繁發行 | 里程碑發行 |
+
+## 工作流程整合
+
+```yaml
+# GitHub Actions example
+name: Release
+on:
+  push:
+    branches: [main]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Generate Changelog
+        run: npx conventional-changelog -p angular -i CHANGELOG.md -s
+
+      - name: Commit Changelog
+        run: |
+          git config user.name "github-actions"
+          git config user.email "github-actions@github.com"
+          git add CHANGELOG.md
+          git commit -m "docs: update changelog" || true
+          git push
+```
+
+## 相關選項
+
+- [Keep a Changelog](./keep-a-changelog.md) - 用於手動維護 changelog
+
+---
+
+## 參考資料
+
+- [Conventional Changelog](https://github.com/conventional-changelog/conventional-changelog)
+- [Semantic Release](https://semantic-release.gitbook.io/)
+- [Git Cliff](https://git-cliff.org/)
+- [Release Please](https://github.com/googleapis/release-please)
+
+---
+
+## 授權
+
+本文件以 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 釋出。
+
+**來源**: [universal-dev-standards](https://github.com/AsiaOstrich/universal-dev-standards)

package/bundled/locales/zh-TW/options/changelog/keep-a-changelog.md

@@ -0,0 +1,140 @@
+---
+source: options/changelog/keep-a-changelog.md
+source_version: 1.0.0
+translation_version: 1.0.0
+status: current
+---
+
+# Keep a Changelog
+
+> **語言**: [English](../../../../options/changelog/keep-a-changelog.md) | 繁體中文
+
+**上層標準**: [Changelog Standards](../../core/changelog-standards.md)
+
+---
+
+## 概觀
+
+Keep a Changelog 是維護人類可讀變更日誌的標準格式。它強調清晰與一致性，讓使用者與開發者能輕鬆理解各版本之間有哪些變更。
+
+## 最適用於
+
+- 開源專案
+- 需要人類可讀變更日誌的專案
+- 遵循 Semantic Versioning 的專案
+- 手動發行管理
+- 重視精心撰寫之發行說明的專案
+
+## 格式結構
+
+```markdown
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [X.Y.Z] - YYYY-MM-DD
+
+### Added
+- New features
+
+### Changed
+- Changes in existing functionality
+
+### Deprecated
+- Soon-to-be removed features
+
+### Removed
+- Removed features
+
+### Fixed
+- Bug fixes
+
+### Security
+- Security vulnerability fixes
+```
+
+## 變更類型
+
+| 類型 | 順序 | 描述 |
+|------|-------|-------------|
+| **Added** | 1 | 新增功能 |
+| **Changed** | 2 | 既有功能的變更 |
+| **Deprecated** | 3 | 即將移除的功能 |
+| **Removed** | 4 | 已移除的功能 |
+| **Fixed** | 5 | 錯誤修正 |
+| **Security** | 6 | 安全漏洞修正 |
+
+## 核心原則
+
+1. **變更日誌是寫給人看的** - 不是機器產生的 commit 傾印
+2. **每個版本都有區段** - 即使沒有變更
+3. **依類型分組** - 使用標準變更類型
+4. **日期採 ISO 格式** - 使用 YYYY-MM-DD
+5. **最新在前** - 反向時間順序排列
+6. **Unreleased 區段** - 追蹤進行中的變更
+
+## 範例條目
+
+```markdown
+## [1.2.0] - 2025-01-15
+
+### Added
+- User authentication with OAuth2 support (#123)
+- Dark mode theme option (#145)
+
+### Changed
+- Updated API response format for consistency
+
+### Fixed
+- Login timeout issue on slow networks (#156)
+
+### Security
+- Updated dependencies to patch CVE-2025-1234
+
+[Unreleased]: https://github.com/user/repo/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/user/repo/compare/v1.1.0...v1.2.0
+```
+
+## 規則
+
+| 規則 | 描述 | 優先級 |
+|------|-------------|----------|
+| 使用 [Unreleased] | 開發期間新增條目 | Required |
+| 發行時移動 | 將條目移至帶日期的版本區段 | Required |
+| 反向時間順序 | 最新版本置於頂部 | Required |
+| 連結版本 | 在檔案底部加入 diff 連結 | Recommended |
+| ISO 日期 | 使用 YYYY-MM-DD 格式 | Required |
+
+## 與自動產生方式的比較
+
+| 面向 | Keep a Changelog | 自動產生 |
+|--------|-----------------|----------------|
+| 投入心力 | 高（手動撰寫） | 低（自動化） |
+| 一致性 | 不一（人工撰寫） | 高（基於範本） |
+| 細節層級 | 功能層級（精心整理） | commit 層級 |
+| 前置條件 | 無 | Conventional Commits |
+| 最適用於 | 里程碑發行 | 頻繁發行 |
+
+## 相關選項
+
+- [Auto-Generated Changelog](./auto-generated.md) - 用於自動化變更日誌產生
+
+---
+
+## 參考資料
+
+- [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
+- [Semantic Versioning](https://semver.org/)
+
+---
+
+## 授權
+
+本文件以 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 授權釋出。
+
+**來源**: [universal-dev-standards](https://github.com/AsiaOstrich/universal-dev-standards)

package/bundled/locales/zh-TW/options/code-review/automated-review.md

@@ -0,0 +1,214 @@
+---
+source: options/code-review/automated-review.md
+source_version: 1.0.0
+translation_version: 1.0.0
+status: current
+---
+
+# 自動化程式碼審查
+
+> **語言**: [English](../../../../options/code-review/automated-review.md) | 繁體中文
+
+**上層標準**: [Code Review Checklist](../../core/code-review-checklist.md)
+
+---
+
+## 概觀
+
+自動化程式碼審查運用工具來分析程式碼以找出問題、強制執行標準，並在人工審查前攔截常見問題。它透過一致且即時地處理重複性檢查，補足人工審查的不足。
+
+## 最適用於
+
+- 及早攔截常見問題
+- 一致地強制執行程式碼標準
+- 減輕審查者的負擔
+- CI/CD 整合
+- 大型程式庫
+- 分散式團隊
+
+## 工具類別
+
+### Static Analysis (SAST)
+
+不執行程式碼即進行分析。
+
+| Tool | 語言 | 重點 |
+|------|-----------|-------|
+| **ESLint** | JavaScript, TypeScript | 程式碼品質、風格 |
+| **Pylint** | Python | 程式碼品質、錯誤 |
+| **SonarQube** | 多語言 | 程式碼品質、安全性 |
+| **Checkstyle** | Java | 風格、慣例 |
+| **RuboCop** | Ruby | 風格、最佳實踐 |
+| **golangci-lint** | Go | 多個 linter |
+
+### 安全性掃描
+
+找出安全性漏洞。
+
+| Tool | 重點 |
+|------|-------|
+| **Snyk** | 相依套件漏洞 |
+| **CodeQL** | 語意式程式碼分析 |
+| **Bandit** | Python 安全性問題 |
+| **Semgrep** | 自訂安全性規則 |
+| **Brakeman** | Ruby on Rails 安全性 |
+
+### 格式化
+
+程式碼風格強制執行。
+
+| Tool | 語言 |
+|------|-----------|
+| **Prettier** | JavaScript, TypeScript, CSS, HTML |
+| **Black** | Python |
+| **gofmt** | Go |
+| **rustfmt** | Rust |
+| **clang-format** | C, C++ |
+
+### 型別檢查
+
+型別安全驗證。
+
+| Tool | 語言 |
+|------|-----------|
+| **TypeScript** | TypeScript, JavaScript |
+| **mypy** | Python |
+| **Flow** | JavaScript |
+
+### AI 驅動審查
+
+| Tool | 說明 |
+|------|-------------|
+| **GitHub Copilot** | AI 建議與審查 |
+| **CodeRabbit** | AI PR 審查留言 |
+| **Sourcery** | Python 程式碼改進 |
+
+## CI 整合
+
+### GitHub Actions
+
+```yaml
+name: Code Review
+on: [pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: npm ci
+      - run: npm run lint
+
+  security:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: snyk/actions/node@master
+
+  format-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: npm run format:check
+```
+
+### GitLab CI
+
+```yaml
+lint:
+  stage: test
+  script:
+    - npm run lint
+
+security:
+  stage: test
+  script:
+    - snyk test
+```
+
+## 規則
+
+| 規則 | 說明 | 優先級 |
+|------|-------------|----------|
+| 錯誤時失敗 | 對重大問題阻擋合併 | Required |
+| 警告作為建議 | 不阻擋的建議 | Recommended |
+| 設定置於 repo 中 | 將工具設定存放於儲存庫 | Required |
+| Pre-commit hooks | 於 commit 前執行檢查 | Recommended |
+
+## 建議設定
+
+### 最低
+
+- 主要語言的 linter
+- 格式化工具（啟用自動修正）
+- 相依套件漏洞掃描器
+
+### 建議
+
+- 所有最低工具
+- 型別檢查器（若適用）
+- 安全性掃描器
+- 程式碼覆蓋率檢查
+
+### 全面
+
+- 所有建議工具
+- AI 程式碼審查
+- 專案專屬的自訂規則
+- 指標追蹤
+
+## 與人工審查的比較
+
+| 面向 | 自動化 | 人工審查 |
+|--------|-----------|---------------|
+| 速度 | 即時 | 數小時／數天 |
+| 一致性 | 100% | 不一定 |
+| 情境理解 | 有限 | 高 |
+| 商業邏輯 | 無法驗證 | 可驗證 |
+| 風格強制執行 | 優異 | 不一致 |
+| 安全性基礎 | 良好 | 可能遺漏 |
+| 成本 | 工具授權 | 開發者時間 |
+
+## Pre-commit Hooks
+
+```yaml
+# .pre-commit-config.yaml
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+
+  - repo: https://github.com/psf/black
+    rev: 24.1.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.0.0
+    hooks:
+      - id: flake8
+```
+
+## 相關選項
+
+- [PR Review](./pr-review.md) - 傳統的 pull request 審查
+- [Pair Programming](./pair-programming.md) - 即時協作審查
+
+---
+
+## 參考資料
+
+- [SonarQube](https://www.sonarqube.org/)
+- [ESLint](https://eslint.org/)
+- [Snyk](https://snyk.io/)
+- [Pre-commit](https://pre-commit.com/)
+
+---
+
+## 授權
+
+本文件以 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 釋出。
+
+**來源**: [universal-dev-standards](https://github.com/AsiaOstrich/universal-dev-standards)

package/bundled/locales/zh-TW/options/code-review/pair-programming.md

@@ -0,0 +1,166 @@
+---
+source: options/code-review/pair-programming.md
+source_version: 1.0.0
+translation_version: 1.0.0
+status: current
+---
+
+# Pair Programming
+
+> **語言**: [English](../../../../options/code-review/pair-programming.md) | 繁體中文
+
+**上層標準**: [Code Review Checklist](../../core/code-review-checklist.md)
+
+---
+
+## 概觀
+
+Pair programming 是一種即時協作的程式碼審查方式，由兩位開發者在同一台工作站上共同作業。一人負責撰寫程式碼（Driver），另一人負責審查與引導（Navigator）。此方法能提供即時回饋，並促進知識傳遞。
+
+## 最適用於
+
+- 需要深入思考的複雜功能
+- 知識傳遞與新人上手
+- 關鍵的程式碼路徑
+- 連線品質良好的同地或遠端團隊
+- 資淺開發者的指導
+
+## 角色
+
+### Driver
+**撰寫程式碼**
+- 實作解決方案
+- 說明思考過程
+- 接納 navigator 的建議
+- 專注於戰術層面的實作
+
+### Navigator
+**審查與引導**
+- 即時審查程式碼
+- 思考更全面的大方向
+- 提出改進建議
+- 及早抓出錯誤
+- 考量邊界情況
+
+## 配對模式
+
+### Ping Pong
+
+最適合 TDD 工作流程。
+
+1. Driver 撰寫一個失敗的測試
+2. 交換角色
+3. 新的 driver 讓測試通過
+4. 新的 driver 撰寫下一個失敗的測試
+5. 交換並重複
+
+### Strong-Style
+
+最適合知識傳遞。
+
+**規則**：「想法要從你的腦袋進到電腦裡，必須經過別人的雙手」
+
+- Navigator 必須將所有想法說出來
+- Driver 只輸入 navigator 口述的內容
+- 確保完整的知識傳遞
+
+### Driver-Navigator（傳統）
+
+最常見的模式。
+
+1. Driver 專注於戰術層面的編碼
+2. Navigator 進行策略性思考
+3. 每 25–30 分鐘交換一次
+4. 雙方都貢獻想法
+
+## 會議準則
+
+### 準備
+- 為本次會議定義明確目標
+- 設置共用的開發環境
+- 對配對模式達成共識
+- 排除干擾
+
+### 會議進行中
+- 每 45–60 分鐘休息一次
+- 定期交換角色（25–30 分鐘）
+- 持續溝通
+- 保持投入與專注
+
+### 會議結束後
+- 簡短的回顧
+- 記錄所做的決策
+- Commit 並 push 程式碼
+- 分享學到的心得
+
+## 工具
+
+### 遠端配對
+| 工具 | 平台 | 功能 |
+|------|------|------|
+| VS Code Live Share | VS Code | 即時編輯、終端機 |
+| JetBrains Code With Me | JetBrains IDEs | 完整 IDE 共享 |
+| Tuple | macOS | 低延遲、繪圖 |
+| Screen sharing | 任何平台 | 備援選項 |
+
+### 本地配對
+- 一台電腦搭配兩組鍵盤／滑鼠
+- 大型螢幕或投影機
+- 舒適的座位安排
+
+## 規則
+
+| 規則 | 描述 | 優先級 |
+|------|------|--------|
+| 定期交換 | 每 25–30 分鐘交換角色 | Required |
+| 口語溝通 | 提出建議前先說明理由 | Required |
+| 尊重 driver | 用口語引導，不要搶鍵盤 | Required |
+| 適時休息 | 每 45–60 分鐘休息一次 | Recommended |
+| 保持投入 | 雙方都應保持主動 | Required |
+
+## 與 PR Review 的比較
+
+| 面向 | Pair Programming | PR Review |
+|------|------------------|-----------|
+| 時機 | 即時 | 非同步 |
+| 回饋 | 立即 | 延遲 |
+| 知識分享 | 高 | 中 |
+| 文件化 | 較低 | 較高（PR 留言） |
+| 可擴展性 | 受限 | 高 |
+| 遠端友善度 | 具挑戰性 | 容易 |
+| 成本 | 較高（2 人） | 較低 |
+
+## 何時使用
+
+### 適合的情境
+- 複雜的演算法
+- 關鍵的安全性程式碼
+- 新團隊成員上手
+- 探索不熟悉的程式庫
+- 設計決策
+
+### 不適合的情境
+- 簡單、例行的任務
+- 個人研究／探索
+- 行政性的程式碼變更
+- 任一方感到疲憊時
+
+## 相關選項
+
+- [PR Review](./pr-review.md) - 非同步程式碼審查
+- [Automated Review](./automated-review.md) - 工具輔助審查
+
+---
+
+## 參考資料
+
+- [Pair Programming Illuminated](https://www.amazon.com/Pair-Programming-Illuminated-Laurie-Williams/dp/0201745763)
+- [Martin Fowler on Pair Programming](https://martinfowler.com/articles/on-pair-programming.html)
+
+---
+
+## 授權
+
+本文件以 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 釋出。
+
+**來源**: [universal-dev-standards](https://github.com/AsiaOstrich/universal-dev-standards)