zhoujie
2ba87c8f6e
- 新增 GitHub Issue 模板（Bug 报告、功能请求）和 Pull Request 模板 - 新增 Code of Conduct（贡献者行为准则）和 Security Policy（安全政策） - 新增 CI 工作流（GitHub Actions），包含 ruff 代码检查和导入验证 - 新增开发依赖文件 requirements-dev.txt 📦 build(ci): 配置 GitHub Actions 持续集成 - 在 push 到 main 分支和 pull request 时自动触发 CI - 添加 lint 任务执行 ruff 代码风格检查 - 添加 import-check 任务验证核心服务模块导入 ♻️ refactor(structure): 重构项目目录结构 - 将根目录的 6 个服务模块迁移至 services/ 包 - 更新所有相关文件的导入语句（main.py、ui/、services/） - 根目录仅保留 main.py 作为唯一 Python 入口文件 🔧 chore(config): 调整配置和资源文件路径 - 将 config.json 移至 config/ 目录，更新相关引用 - 将个人头像图片移至 assets/faces/ 目录，更新 .gitignore - 更新 Dockerfile 和 docker-compose.yml 中的配置路径 📝 docs(readme): 完善 README 文档 - 添加项目状态徽章（Python 版本、License、CI） - 更新项目结构图反映实际目录布局 - 修正使用指南中的 Tab 名称和操作路径 - 替换 your-username 占位符为格式提示 🗑️ chore(cleanup): 清理冗余文件 - 删除旧版备份文件、测试脚本、临时记录和运行日志 - 删除散落的个人图片文件（已归档至 assets/faces/）
1.9 KiB
1.9 KiB
ADDED Requirements
Requirement: 提供标准化 GitHub Issue 模板
项目 SHALL 在 .github/ISSUE_TEMPLATE/ 下提供至少两个 Issue 模板：Bug 报告模板和功能请求模板，引导贡献者提供必要信息。
Scenario: Bug 报告模板包含必要字段
- WHEN 用户在 GitHub 上新建 Issue 并选择「Bug 报告」
- THEN 模板 SHALL 包含：问题描述、复现步骤、预期行为、实际行为、环境信息（Python 版本、操作系统）
Scenario: 功能请求模板包含场景描述
- WHEN 用户选择「功能请求」模板
- THEN 模板 SHALL 包含：问题/需求背景、期望的解决方案、替代方案考虑
Requirement: 提供 Pull Request 模板
项目 SHALL 在 .github/pull_request_template.md 提供 PR 模板，引导贡献者说明变更范围和测试情况。
Scenario: PR 模板包含变更说明和测试确认
- WHEN 贡献者在 GitHub 上发起 Pull Request
- THEN 模板 SHALL 包含：变更类型（Bug Fix / Feature / Docs / Refactor）、变更描述、测试说明、相关 Issue 引用
Requirement: 包含行为准则文件
项目根目录 SHALL 包含 CODE_OF_CONDUCT.md，采用 Contributor Covenant v2.1 中文版，明确社区行为规范和违规处理方式。
Scenario: 行为准则文件可访问
- WHEN 贡献者查看项目根目录
- THEN
CODE_OF_CONDUCT.mdSHALL 存在，包含社区行为规范、适用范围、执行说明、联系方式
Requirement: 包含安全漏洞报告政策
项目根目录 SHALL 包含 SECURITY.md，说明如何负责任地披露安全漏洞、支持的版本范围和响应时间承诺。
Scenario: 安全政策文件包含报告方式
- WHEN 安全研究者发现漏洞
- THEN
SECURITY.mdSHALL 提供私下联系方式（邮件或 GitHub Security Advisory），不要求通过公开 Issue 上报