mirror of https://gitee.com/spark-store-project/spark-store synced 2026-04-26 09:20:18 +08:00

Files

momen cef68a95d9 chore: add comprehensive documentation and testing infrastructure

## 文档（全部中文）
- AGENTS.md - 完整的 AI 编码指南（中文版）
- CONTRIBUTING.md - 贡献指南
- DEVELOPMENT.md - 开发文档
- DEPLOYMENT.md - 部署文档
- TESTING.md - 测试文档
- TROUBLESHOOTING.md - 问题排查指南
- FAQ.md - 常见问题
- WORKFLOW.md - 标准开发流程文档
## AI 工作流（9个详细工作流）
- feature-development.md - 新功能开发流程
- bug-fix.md - Bug 修复流程
- code-review.md - 代码审查流程
- testing.md - 测试编写流程
- release.md - 发布流程
- refactoring.md - 代码重构流程
- documentation.md - 文档更新流程
- performance-optimization.md - 性能优化流程
- security-audit.md - 安全审计流程
## 测试基础设施
- vitest.config.ts - Vitest 单元测试配置
- playwright.config.ts - Playwright E2E 测试配置
- src/__tests__/setup.ts - 测试环境设置
- src/__tests__/unit/downloadStatus.test.ts - 示例单元测试
- e2e/basic.spec.ts - 示例 E2E 测试
## CI/CD
- .github/workflows/test.yml - 新建测试 CI 工作流
- .github/workflows/build.yml - 更新构建工作流，添加测试步骤
## Issue 模板
- 更新 bug_report.md 为标准 Bug 报告模板
- 更新 help_wanted.md 为标准功能请求模板
## 配置更新
- package.json - 添加测试依赖和 7 个新的 npm 脚本
- .gitignore - 添加测试相关忽略项
## 新增 npm 脚本
- test - 运行单元测试
- test:watch - 监听模式
- test:coverage - 生成覆盖率报告
- test:e2e - 运行 E2E 测试
- test:e2e:ui - E2E UI 模式
- test:e2e:debug - E2E 调试模式
- test:all - 运行所有测试
## 新增测试依赖
- @playwright/test ^1.40.0
- @testing-library/jest-dom ^6.1.5
- @testing-library/vue ^8.0.1
- @vitest/coverage-v8 ^1.0.0
- @vue/test-utils ^2.4.3
- jsdom ^23.0.1
- vitest ^1.0.0

2026-03-10 00:42:56 +08:00

4.8 KiB

Raw Blame History

贡献指南

感谢您对 APM 应用商店项目的关注！我们欢迎任何形式的贡献。

📋 目录

行为准则
如何贡献
开发流程
代码规范
提交信息规范
Pull Request 流程
问题报告

行为准则

尊重所有贡献者
接受建设性批评
专注于对项目最有利的事情
对社区表现出同理心

如何贡献

报告 Bug

使用 Bug 报告模板
搜索现有 Issue，避免重复
提供清晰的重现步骤
包含相关日志和截图

建议新功能

使用功能请求模板
解释使用场景和需求
考虑是否值得投入开发资源
愿意帮助实现吗？

提交代码

Fork 项目并创建分支
编写代码和测试
确保所有测试通过
提交 Pull Request

改进文档

修正错误或不清晰之处
添加示例和教程
翻译文档
提出文档改进建议

开发流程

环境搭建

# 克隆仓库
git clone https://github.com/elysia-best/apm-app-store.git
cd apm-app-store

# 安装依赖
npm install

# 启动开发服务器
npm run dev

创建分支

# 功能分支
git checkout -b feature/your-feature-name

# Bug 修复分支
git checkout -b fix/your-bug-fix

本地开发

遵循代码规范
编写单元测试
运行 npm run lint 和 npm run format
运行 npm run test 确保测试通过

代码审查

保持 PR 小而聚焦
添加清晰的描述
引用相关的 Issue
回应审查意见

代码规范

TypeScript

使用严格模式 (strict: true)
避免使用 any 类型（必要时使用 eslint-disable 注释）
使用显式类型注解
优先使用 interface 而非 type

Vue 3

使用 Composition API 和 <script setup>
使用 ref 和 computed 管理状态
遵循 Props 和 Events 模式
组件名使用 PascalCase

样式（Tailwind CSS）

优先使用 Tailwind 工具类
支持暗色模式（dark: 前缀）
响应式设计（md:, lg: 前缀）

命名约定

组件: PascalCase (AppCard.vue)
函数: camelCase (handleInstall)
常量: UPPER_SNAKE_CASE (SHELL_CALLER_PATH)
文件: kebab-case (install-manager.ts)

提交信息规范

遵循 Conventional Commits 规范。

格式

type(scope): subject

[可选的正文]

[可选的脚注]

Type 类型

feat: 新功能
fix: Bug 修复
docs: 文档更新
style: 代码格式（不影响功能）
refactor: 重构
perf: 性能优化
test: 测试相关
chore: 构建/工具相关

Scope 范围

app: 应用核心
install: 安装/卸载
ui: UI 组件
ipc: IPC 通信
api: API 集成
theme: 主题
build: 构建
docs: 文档

Subject 主题

使用现在时态（"add" 而非 "added"）
首字母小写
不以句号结尾

示例

feat(install): add retry mechanism for failed installations
fix(ui): correct dark mode toggle persistence
refactor(ipc): simplify install manager event handling
docs(readme): update build instructions
test(download): add unit tests for download queue

签名（可选）

添加签名以遵守 DCO（Developer Certificate of Origin）：

git commit -m "feat(example): add new feature" -s

或在 ~/.gitconfig 中配置：

[commit]
    gpgsign = true

Pull Request 流程

PR 前检查

代码通过 npm run lint
代码通过 npm run format
所有测试通过 (npm run test)
新功能包含测试
文档已更新（如需要）

PR 描述

使用 PR 模板，包括：

变更类型: feat / fix / refactor 等
变更描述: 清晰说明做了什么
相关 Issue: 引用 #123
测试说明: 如何测试这些变更
截图/录屏: UI 变更需要
检查清单: 完成上述 PR 前检查

审查流程

至少一位维护者审查通过
解决所有审查意见
确保所有 CI 检查通过
Squash 并合并到 main 分支

合并要求

CI 检查全部通过
至少一次审查批准
无冲突
分支最新

问题报告

Bug 报告

使用 Bug 报告模板，包含：

描述
复现步骤
期望行为
实际行为
环境信息
截图/日志

功能请求

使用功能请求模板，包含：

问题描述
期望的解决方案
替代方案
额外上下文

4.8 KiB Raw Blame History Unescape Escape