universal-dev-standards 5.17.0 → 6.1.0

package/bundled/locales/zh-CN/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-CN/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-CN/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-CN/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)