mirror of
https://github.com/truewhile/MeBox.git
synced 2026-09-29 03:26:37 +08:00
docs: add contribution guidelines
This commit is contained in:
@@ -0,0 +1,52 @@
|
||||
---
|
||||
name: Bug 反馈
|
||||
about: 报告可复现的问题、报错、功能异常或回归
|
||||
title: "[Bug] "
|
||||
labels: bug
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
## 问题现象
|
||||
|
||||
请描述实际发生了什么。
|
||||
|
||||
## 期望行为
|
||||
|
||||
请描述你认为正确结果应该是什么。
|
||||
|
||||
## 复现步骤
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## 部署方式
|
||||
|
||||
- 部署方式:Docker 第一档 / 第二档 / 第三档 / 裸机 / 其他
|
||||
- 镜像或版本:
|
||||
- NAS / 系统:
|
||||
- Docker 版本:
|
||||
- Docker Compose 版本:
|
||||
- 浏览器:
|
||||
|
||||
## 关键配置
|
||||
|
||||
请贴出相关配置片段,例如路径映射、媒体库路径、下载器保存路径、站点类型等。
|
||||
|
||||
请务必隐藏 Cookie、API Key、Passkey、密码、Token 和私有下载链接。
|
||||
|
||||
```yaml
|
||||
# docker-compose.yml 相关片段
|
||||
```
|
||||
|
||||
## 日志 / 任务详情
|
||||
|
||||
请附上应用日志、任务队列详情、浏览器控制台错误或网络请求错误。
|
||||
|
||||
```text
|
||||
|
||||
```
|
||||
|
||||
## 补充信息
|
||||
|
||||
截图、录屏、相关 Issue、你已经尝试过的排查步骤。
|
||||
@@ -0,0 +1,5 @@
|
||||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Telegram MediaStationGo 交流群
|
||||
url: https://t.me/MediaStationGo
|
||||
about: 适合快速交流部署经验、使用问题和排查线索。
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
name: 功能建议
|
||||
about: 提出新功能、体验改进或兼容性需求
|
||||
title: "[Feature] "
|
||||
labels: enhancement
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
## 需求背景
|
||||
|
||||
这个功能解决什么问题?当前使用流程哪里不方便?
|
||||
|
||||
## 期望方案
|
||||
|
||||
请描述你希望 MediaStationGo 如何工作。
|
||||
|
||||
## 使用场景
|
||||
|
||||
- 部署环境:
|
||||
- 相关页面或模块:
|
||||
- 受影响用户:
|
||||
|
||||
## 可接受的替代方案
|
||||
|
||||
如果有其他实现方式或临时解决办法,也请写出来。
|
||||
|
||||
## 补充信息
|
||||
|
||||
截图、竞品参考、API 文档、相关讨论链接等。
|
||||
@@ -0,0 +1,40 @@
|
||||
## 背景
|
||||
|
||||
说明这个 PR 解决的问题、关联 Issue 或用户场景。
|
||||
|
||||
> 请确认本 PR 基于本仓库最新 `main` 的独立分支或 fork 分支提交,未直接向 `main` 推送,也未夹带个人部署魔改配置。
|
||||
|
||||
## 改动摘要
|
||||
|
||||
-
|
||||
|
||||
## 验证
|
||||
|
||||
- [ ] `go test ./...`
|
||||
- [ ] `npm --prefix web run build`
|
||||
- [ ] `git diff --check`
|
||||
- [ ] 其他:
|
||||
|
||||
## 风险与兼容性
|
||||
|
||||
- 是否影响 Docker / NAS 路径映射:
|
||||
- 是否影响数据库迁移或数据结构:
|
||||
- 是否影响下载器、订阅、站点 API 或限流:
|
||||
- 是否包含敏感信息脱敏:
|
||||
|
||||
## 截图 / 日志
|
||||
|
||||
涉及 UI、任务队列、错误提示、设置页时请附截图或日志片段。
|
||||
|
||||
```text
|
||||
|
||||
```
|
||||
|
||||
## 提交前检查
|
||||
|
||||
- [ ] 分支已同步最新 `main`,不是直接在 `main` 上提交。
|
||||
- [ ] PR 范围聚焦,没有夹带无关重构。
|
||||
- [ ] 未提交个人部署配置、私有路径、API Key、Cookie、Token 或私有镜像标签。
|
||||
- [ ] 用户可见错误有清晰提示或日志。
|
||||
- [ ] 新行为有测试覆盖,或已说明无法覆盖的原因。
|
||||
- [ ] 文档、示例配置、README 已按需同步。
|
||||
Reference in New Issue
Block a user