chore: 完善开源项目文档与结构,移除敏感原始图片
- 重写 README.md,添加在线体验、API 文档、部署指南、技术栈等 - 添加 MIT LICENSE - 添加 CONTRIBUTING.md 贡献指南 - 添加 GitHub Issue/PR 模板 - 完善 .gitignore,防止原始图片和敏感文件误提交 - 从 git 中移除 25 个原始图片文件(.png/.jpg/非序号 webp) - 项目结构迁移:functions/ -> src/,根目录静态文件 -> public/ - 添加 wrangler.toml 与 package.json 配置
This commit is contained in:
40
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
40
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
name: Bug 报告
|
||||
about: 报告一个 Bug 或异常行为
|
||||
title: "[Bug] "
|
||||
labels: bug
|
||||
---
|
||||
|
||||
## 问题描述
|
||||
|
||||
清晰简洁地描述你遇到的 Bug。
|
||||
|
||||
## 复现步骤
|
||||
|
||||
1. 步骤一
|
||||
2. 步骤二
|
||||
3. 步骤三
|
||||
|
||||
## 预期行为
|
||||
|
||||
描述你期望发生的结果。
|
||||
|
||||
## 实际行为
|
||||
|
||||
描述实际发生的结果。
|
||||
|
||||
## 环境信息
|
||||
|
||||
- **操作系统**: [例如 Windows 11 / macOS / Ubuntu]
|
||||
- **Node.js 版本**: [例如 20.0.0]
|
||||
- **Python 版本**: [例如 3.12]
|
||||
- **Wrangler 版本**: [例如 4.x]
|
||||
- **浏览器**: [如适用]
|
||||
|
||||
## 截图或日志
|
||||
|
||||
如有截图或错误日志,请贴在这里。
|
||||
|
||||
## 补充说明
|
||||
|
||||
任何其他上下文信息。
|
||||
26
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
26
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
name: 功能建议
|
||||
about: 为项目提出新功能或改进建议
|
||||
title: "[Feature] "
|
||||
labels: enhancement
|
||||
---
|
||||
|
||||
## 功能描述
|
||||
|
||||
清晰简洁地描述你想要的功能或改进。
|
||||
|
||||
## 使用场景
|
||||
|
||||
描述这个功能会在什么场景下使用,解决什么问题。
|
||||
|
||||
## 可能的实现方案
|
||||
|
||||
如果你有实现思路,可以简要描述。
|
||||
|
||||
## 替代方案
|
||||
|
||||
是否考虑过其他替代方案?
|
||||
|
||||
## 补充说明
|
||||
|
||||
任何其他上下文信息。
|
||||
26
.github/pull_request_template.md
vendored
Normal file
26
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,26 @@
|
||||
## 描述
|
||||
|
||||
请简要描述这个 PR 的内容和目的。
|
||||
|
||||
## 变更类型
|
||||
|
||||
- [ ] Bug 修复
|
||||
- [ ] 新功能
|
||||
- [ ] 文档更新
|
||||
- [ ] 代码重构
|
||||
- [ ] 性能优化
|
||||
- [ ] 其他
|
||||
|
||||
## 检查清单
|
||||
|
||||
- [ ] 代码已测试,本地 `npm run dev` 可正常运行
|
||||
- [ ] 没有提交敏感信息(API Key、账号等)
|
||||
- [ ] 没有提交原始图片到根目录 `mobile-image/` / `desketop-image/`
|
||||
- [ ] 相关文档已更新(README / CONTRIBUTING)
|
||||
- [ ] 提交信息符合 Conventional Commits 规范
|
||||
|
||||
## 关联 Issue
|
||||
|
||||
如有,请填写:
|
||||
|
||||
Fixes #(issue 编号)
|
||||
Reference in New Issue
Block a user