mirror of
https://github.com/JefferyHcool/BiliNote.git
synced 2026-05-11 18:10:06 +08:00
把 CONTRIBUTING.md 里写的规范落到 GitHub 工程化层。
Issue / PR 模板:
- .github/ISSUE_TEMPLATE/{config,bug_report,feature_request}.yml
· yml 表单形式,跟随当前工作区分类(backend / frontend / extension / Tauri)
· bug_report 强制选版本 + 部署方式 + 复现步骤;提交前自查不夹带 secrets
· config.yml 禁用空白 issue,引导 Discussions
- .github/pull_request_template.md:把 CONTRIBUTING §5.2 的 PR 正文要求落成 checklist
- 删旧版 .md 模板(含中文文件名那条),避免新老两套并存
Commitlint:
- .commitlintrc.json:extend conventional + 自定义 type 白名单(feat/fix/docs/style/refactor/perf/test/build/ci/chore/ui/revert)
- .github/workflows/commitlint.yml:用 wagoid/commitlint-github-action@v6,PR + push develop/master 时校验
· subject-case / subject-full-stop 关掉,兼容中文 subject
· header-max-length 100 字符 warn 级别,不阻塞合并
插件发版工作流:
- .github/workflows/release-extension.yml:v* tag push 时
· cd BillNote_extension && pnpm install + build
· pack:zip / pack:xpi / pack:crx(crx 缺 key 自动跳过)
· 产物重命名带版本后缀,挂到对应 GitHub Release
- 末尾保留 publish-chrome / publish-edge / publish-firefox 三段注释,配齐 secrets 即可启用商店自动发布
- RELEASING.md:发版执行手册,覆盖 release/* 流程 + 各商店人工上传步骤 + 自动发布所需 secrets
CONTRIBUTING.md 关联文档区指到新增的 RELEASING.md,commit 章节加 commitlint 落地说明。
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
94 lines
2.6 KiB
YAML
94 lines
2.6 KiB
YAML
name: 🐛 Bug 报告
|
||
description: 报告一个可复现的问题
|
||
title: "[Bug] "
|
||
labels: ["bug"]
|
||
body:
|
||
- type: markdown
|
||
attributes:
|
||
value: |
|
||
感谢反馈。请尽量提供完整的复现路径与日志,便于排查。
|
||
⚠️ **不要**贴 API key、SESSDATA、密钥等敏感信息。
|
||
- type: dropdown
|
||
id: workspace
|
||
attributes:
|
||
label: 受影响的工作区
|
||
multiple: true
|
||
options:
|
||
- 后端 (backend/)
|
||
- Web 前端 (BillNote_frontend/)
|
||
- 浏览器插件 (BillNote_extension/)
|
||
- Tauri 桌面端
|
||
- 文档 / 其他
|
||
validations:
|
||
required: true
|
||
- type: input
|
||
id: version
|
||
attributes:
|
||
label: 版本
|
||
description: BiliNote 版本号(README 顶部,例如 v2.1.0)
|
||
placeholder: v2.1.0
|
||
validations:
|
||
required: true
|
||
- type: dropdown
|
||
id: deploy
|
||
attributes:
|
||
label: 部署方式
|
||
options:
|
||
- 源码运行
|
||
- Docker (docker-compose.yml)
|
||
- Docker GPU (docker-compose.gpu.yml)
|
||
- 桌面端安装包 (Tauri Release)
|
||
- 其他
|
||
validations:
|
||
required: true
|
||
- type: textarea
|
||
id: repro
|
||
attributes:
|
||
label: 复现步骤
|
||
description: 一步步说明如何触发问题
|
||
placeholder: |
|
||
1. 打开 ...
|
||
2. 点击 ...
|
||
3. 看到 ...
|
||
validations:
|
||
required: true
|
||
- type: textarea
|
||
id: expected
|
||
attributes:
|
||
label: 期望行为
|
||
validations:
|
||
required: true
|
||
- type: textarea
|
||
id: actual
|
||
attributes:
|
||
label: 实际行为
|
||
description: 含错误信息、截图、录屏均可
|
||
validations:
|
||
required: true
|
||
- type: textarea
|
||
id: env
|
||
attributes:
|
||
label: 运行环境
|
||
description: 操作系统、Python 版本、Node 版本、浏览器(如适用)
|
||
placeholder: |
|
||
- OS: macOS 14.5 / Windows 11 / Ubuntu 22.04
|
||
- Python: 3.11.6
|
||
- Node: 20.18.0
|
||
- Browser: Chrome 124(如涉及插件/前端)
|
||
- GPU: 无 / NVIDIA 4070(如涉及 fast-whisper / video understanding)
|
||
- type: textarea
|
||
id: logs
|
||
attributes:
|
||
label: 日志 / 堆栈
|
||
description: 后端 console、前端 DevTools、扩展 background 页都可以贴
|
||
render: text
|
||
- type: checkboxes
|
||
id: pre-checks
|
||
attributes:
|
||
label: 提交前自查
|
||
options:
|
||
- label: 我已搜索过 [Issues](https://github.com/JefferyHcool/BiliNote/issues?q=),确认不是重复问题
|
||
required: true
|
||
- label: 我提供的日志中**不**包含 API key、cookie、SESSDATA 等敏感信息
|
||
required: true
|