docs: 完善仓库文档(README / LICENSE / CONTRIBUTING / CHANGELOG / Issue 与 PR 模板)

- README.md: 仓库门面,含特性、API 文档、快速开始、部署、目录结构、协议

- LICENSE: MIT,约束代码

- ASSET_LICENSE.md: CC BY-NC-SA 4.0,约束表情包素材

- CONTRIBUTING.md: 投稿流程、commit 与分支规范、PR 自检清单

- CHANGELOG.md: Keep a Changelog 格式,1.0.0 首发条目

- .gitignore: 补充 macOS/Windows/IDE/Python/日志等忽略项

- .github/ISSUE_TEMPLATE/: bug / feature / question 三个模板

- .github/PULL_REQUEST_TEMPLATE.md: 含素材来源声明与自检清单
This commit is contained in:
2026-06-04 22:03:02 +08:00
parent e1bfa7a712
commit 1975e51960
10 changed files with 942 additions and 0 deletions

56
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,56 @@
---
name: 🐛 Bug 报告
about: 报告一个让你遇到问题的 bug前端 / API / 构建 / 素材缺失等)
title: '[Bug] '
labels: bug
assignees: ''
---
## 描述
简洁清晰地描述这个 bug 是什么。
## 复现步骤
1. 打开 `https://meme.smyhub.com/...`
2. 点击 `...`
3. 选择 `...`
4. 看到 `...` 而预期是 `...`
## 预期行为
你**期望**发生什么。
## 实际行为
实际发生了什么?错误信息、控制台报错、网络请求等。
## 截图 / 录屏
如果有的话,附上(拖拽到下面即可)。
## 环境
- 浏览器 / 版本:例如 Chrome 125.0 / Safari 17.5 / Firefox 127
- 操作系统:例如 Windows 11 / macOS 14 / iOS 17 / Android 14
- 设备:例如 PC / iPhone 14 / 小米 14
- 页面 URL例如 https://meme.smyhub.com/#白色小人
- 影响的素材路径(如果是某张图坏了):例如 `白色小人/123.webp`
## 浏览器控制台
> 打开 DevToolsF12→ Console 标签,把相关报错贴上来。
```
// 在此粘贴
```
## 额外信息
任何其他可能有用的上下文。
## 检查清单
- [ ] 我已经搜索过 [已有 Issue](https://github.com/shumengya/meme-api/issues?q=is%3Aissue) 确认没人提过
- [ ] 如果是素材问题,确认是仓库里 / 站点上都看不到,而不是我本地缓存
- [ ] 我没有在 Issue 里包含任何个人敏感信息

View File

@@ -0,0 +1,35 @@
---
name: 💡 功能建议
about: 对图库 / API / 构建流程提出改进建议
title: '[Feature] '
labels: enhancement
assignees: ''
---
## 这个功能解决什么问题?
简要说明痛点或动机。例如:
- "我每次都要手动选 HTML 宽度 240希望有记忆"
- "想在手机端把图片长按保存"
## 你想要的方案
描述你心中的实现方式。可以包括:
- UI 截图 / 草图
- 交互流程
- 对哪些 API / 文件有影响
## 备选方案
有没有考虑过别的做法?各自的优缺点?
## 额外信息
- 影响的页面 / API例如 `https://meme.smyhub.com/``/memes.json`
- 是否愿意自己提 PR是 / 否 / 待定
- 关联 Issue如果有#123
## 检查清单
- [ ] 我已经搜索过 [已有 Issue](https://github.com/shumengya/meme-api/issues?q=is%3Aissue) 确认没人提过
- [ ] 我愿意按 [CONTRIBUTING.md](../../CONTRIBUTING.md) 提一个 PR可选

34
.github/ISSUE_TEMPLATE/question.md vendored Normal file
View File

@@ -0,0 +1,34 @@
---
name: ❓ 提问 / 求助
about: 不知道怎么用 / 需要帮助
title: '[Question] '
labels: question
assignees: ''
---
## 我想做什么
简述你想达到的目的。
## 我已经试过的
- 看了 README 里的「...」部分
- 搜了 Issues没找到
- ...
## 困惑点
具体卡在哪?
## 截图 / 代码
如果方便,附上相关截图或代码片段。
## 环境
- 浏览器 / 设备
- 访问的 URL
## 检查清单
- [ ] 我已经搜索过 [已有 Issue](https://github.com/shumengya/meme-api/issues?q=is%3Aissue) 确认没人提过

65
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,65 @@
## 描述
<!-- 一两句话说清这个 PR 干了什么。 -->
## 关联 Issue
<!-- 用 `Closes #123` / `Fixes #123` 关联 issue没关联的写 "无"。 -->
Closes #
## 变更类型
请打勾:
- [ ] 🐛 Bug 修复fix
- [ ] ✨ 新功能feat
- [ ] 🎨 样式 / UI 调整style
- [ ] ♻️ 重构refactor
- [ ] ⚡ 性能优化perf
- [ ] 📝 文档docs
- [ ] 🔧 构建 / 脚本 / 配置chore
- [ ] 🖼 素材投稿(新表情包 / 新分类)
## 改动内容
<!-- 详细列出做了哪些改动。可以按文件 / 模块分点。 -->
-
-
-
## 涉及的文件
<!-- 方便 reviewer 快速定位 -->
- [ ] `public/index.html`
- [ ] `public/meme/...`(素材)
- [ ] `scripts/generate-manifest.mjs`
- [ ] `转化.py`
- [ ] `public/memes.json`(清单,由 `npm run build` 自动重生成)
- [ ] `dist/memes.json`(构建产物,请确认未手动修改)
- [ ] 文档README / CONTRIBUTING / CHANGELOG / 其他)
- [ ] GitHub 配置Issue 模板 / PR 模板 / .github 目录)
## 素材来源声明(仅素材投稿必填)
- **来源**:原创 / 转载自 `xxx` / 协议 `CC BY 4.0` / ...
- **是否商用素材**:否
- **是否涉及他人作品**:否 / 是,已附原始协议与作者
- **协议确认**:我同意按 [CC BY-NC-SA 4.0](./ASSET_LICENSE.md) 发布
## 自检清单
- [ ] 我已经读了 [CONTRIBUTING.md](./CONTRIBUTING.md)
- [ ] 本地 `npm run build` 通过,`public/memes.json` 已重生成
- [ ] 本地 `npm run dev` 跑过,浏览器实测没回归
- [ ] 移动端DevTools 切到 375px布局没崩
- [ ] 改动不引入新外部依赖
- [ ] 没有把 `dist/``node_modules/``__pycache__/``*.pyc``原图/` 里的源文件等 commit 进去
- [ ] 素材若涉他人,已在 PR 描述里写明出处与原始协议
- [ ] 我已更新 [CHANGELOG.md](./CHANGELOG.md)(如适用)
## 截图 / 录屏
<!-- UI 改动请务必附图;素材投稿可以附几张代表图。 -->