npm - universal-dev-standards - Versions diffs - 3.5.1-beta.1 → 3.5.1-beta.11 - Mend

universal-dev-standards 3.5.1-beta.1 → 3.5.1-beta.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (433) hide show

package/bundled/locales/zh-CN/core/commit-message-guide.md ADDED Viewed

@@ -0,0 +1,129 @@
+---
+source: ../../../core/commit-message-guide.md
+source_version: 1.2.3
+translation_version: 1.2.3
+last_synced: 2026-01-08
+status: current
+---
+> **语言**: [English](../../../core/commit-message-guide.md) | [简体中文](../../zh-TW/core/commit-message-guide.md) | 简体中文
+# 提交消息指南
+**版本**: 1.0.0
+**最后更新**: 2025-12-30
+**适用范围**: 所有使用 Git 进行版本控制的项目
+---
+## 目的
+本标准定义如何撰写清晰、有意义的 Git 提交消息，以提升项目历史的可读性和可追溯性。
+---
+## 格式
+### 标准格式
+```
+<type>(<scope>): <subject>
+<body>
+<footer>
+```
+### 组成说明
+| 组成 | 必要性 | 说明 |
+|------|-------|------|
+| type | 必要 | 变更类型 |
+| scope | 可选 | 影响范围 |
+| subject | 必要 | 简短描述 |
+| body | 可选 | 详细说明 |
+| footer | 可选 | 引用、破坏性变更 |
+---
+## 变更类型 (Type)
+| 类型 | 说明 | 示例 |
+|------|------|------|
+| feat | 新功能 | 添加用户登录功能 |
+| fix | 错误修复 | 修复支付金额计算错误 |
+| docs | 文档变更 | 更新 API 文档 |
+| style | 格式调整（不影响代码逻辑） | 调整代码缩进 |
+| refactor | 重构（非新功能、非错误修复） | 重构用户认证模块 |
+| perf | 性能优化 | 优化数据库查询 |
+| test | 测试相关 | 添加单元测试 |
+| build | 构建系统变更 | 更新 webpack 配置 |
+| ci | CI 配置变更 | 更新 GitHub Actions |
+| chore | 其他变更 | 更新依赖版本 |
+| revert | 回滚提交 | 回滚上一次提交 |
+---
+## 示例
+### 简单提交
+```
+feat(auth): add user login functionality
+```
+### 带正文的提交
+```
+fix(payment): correct amount calculation
+The payment amount was being rounded incorrectly
+when processing international transactions.
+Closes #123
+```
+### 破坏性变更
+```
+feat(api)!: change user endpoint response format
+BREAKING CHANGE: The /api/users endpoint now returns
+a different JSON structure. See migration guide.
+```
+---
+## 快速参考卡
+### 提交类型速查
+| 我做了什么？ | 使用类型 |
+|-------------|---------|
+| 添加新功能 | feat |
+| 修复错误 | fix |
+| 更新文档 | docs |
+| 重构代码 | refactor |
+| 优化性能 | perf |
+| 添加测试 | test |
+### 检查清单
+- [ ] 类型正确
+- [ ] 主题简洁（50 字符内）
+- [ ] 使用祈使句
+- [ ] 正文说明"为什么"
+- [ ] 引用相关 issue
+---
+## 相关标准
+- [Git 工作流程](git-workflow.md)
+- [代码审查指南](code-review-guide.md)
+---
+## 许可证
+本标准采用 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 发布。

package/bundled/locales/zh-CN/core/documentation-structure.md ADDED Viewed

@@ -0,0 +1,173 @@
+---
+source: ../../../core/documentation-structure.md
+source_version: 1.2.2
+translation_version: 1.2.2
+last_synced: 2026-01-08
+status: current
+---
+> **语言**: [English](../../../core/documentation-structure.md) | [简体中文](../../zh-TW/core/documentation-structure.md) | 简体中文
+# 文档结构标准
+**版本**: 1.0.0
+**最后更新**: 2025-12-30
+**适用范围**: 所有需要文档的软件项目
+---
+## 目的
+本标准定义项目文档的组织结构和命名规范，确保文档的一致性和可发现性。
+---
+## 目录结构
+### 推荐结构
+```
+project/
+├── README.md              # 项目概述
+├── CHANGELOG.md           # 版本变更记录
+├── CONTRIBUTING.md        # 贡献指南
+├── LICENSE                # 许可证
+├── docs/
+│   ├── getting-started.md # 快速入门
+│   ├── installation.md    # 安装指南
+│   ├── configuration.md   # 配置说明
+│   ├── api/               # API 文档
+│   │   └── README.md
+│   ├── guides/            # 使用指南
+│   │   └── README.md
+│   └── architecture/      # 架构文档
+│       └── README.md
+└── examples/              # 示例代码
+    └── README.md
+```
+---
+## 文件命名
+### 规范
+| 规则 | 示例 |
+|------|------|
+| 使用小写字母 | getting-started.md |
+| 使用连字符分隔 | api-reference.md |
+| 有意义的名称 | configuration.md |
+| 避免特殊字符 | ❌ api_v2(new).md |
+### 常用文件名
+| 文件 | 用途 |
+|------|------|
+| README.md | 目录/项目说明 |
+| CHANGELOG.md | 版本变更 |
+| CONTRIBUTING.md | 贡献指南 |
+| LICENSE | 许可证 |
+| SECURITY.md | 安全政策 |
+| CODE_OF_CONDUCT.md | 行为准则 |
+---
+## README 模板
+### 基本结构
+```markdown
+# 项目名称
+简短描述项目用途。
+## 功能
+- 功能 1
+- 功能 2
+## 安装
+```bash
+npm install package-name
+```
+## 使用
+```javascript
+const pkg = require('package-name');
+pkg.doSomething();
+```
+## 文档
+详细文档请参阅 [docs/](docs/)。
+## 贡献
+欢迎贡献！请阅读 [CONTRIBUTING.md](CONTRIBUTING.md)。
+## 许可证
+[MIT](LICENSE)
+```
+---
+## Markdown 风格
+### 标题
+```markdown
+# 一级标题（仅用于文档标题）
+## 二级标题
+### 三级标题
+```
+### 代码块
+````markdown
+```javascript
+const example = 'code';
+```
+````
+### 链接
+```markdown
+[显示文本](url)
+[相对链接](../other-doc.md)
+```
+---
+## 快速参考卡
+### 必要文件
+| 文件 | 必要性 |
+|------|-------|
+| README.md | 必要 |
+| LICENSE | 必要 |
+| CHANGELOG.md | 推荐 |
+| CONTRIBUTING.md | 推荐 |
+### 命名检查清单
+- [ ] 使用小写字母
+- [ ] 使用连字符分隔单词
+- [ ] 名称描述内容
+- [ ] 无特殊字符
+---
+## 相关标准
+- [API 文档标准](api-documentation-standards.md)
+- [变更日志标准](changelog-standards.md)
+---
+## 许可证
+本标准采用 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 发布。