mirror of
https://github.com/JefferyHcool/BiliNote.git
synced 2026-05-12 19:40:31 +08:00
b2af0e4e53
把 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>
40 lines
1.4 KiB
Markdown
40 lines
1.4 KiB
Markdown
<!--
|
||
PR 标题请遵循 type(scope): subject 格式，例如：
|
||
feat(extension): 侧边栏接入思维导图
|
||
fix(bilibili): 修正字幕优先链路在未登录态下的回退
|
||
分支命名 / 提交规范见 CONTRIBUTING.md。
|
||
-->
|
||
|
||
## 改动概述
|
||
|
||
<!-- 一句话说清这个 PR 做了什么 -->
|
||
|
||
## 为什么
|
||
|
||
<!-- 背景、关联 issue（Fixes #xxx / Refs #xxx）、用户场景 -->
|
||
|
||
## 做了什么
|
||
|
||
<!-- 关键文件、关键决策。可贴关键片段或截图 -->
|
||
|
||
## 测试方式
|
||
|
||
- [ ] `pnpm typecheck && pnpm build`（前端 / 插件）通过
|
||
- [ ] `python -m py_compile <文件>` 或本地 backend 启动验证（后端）通过
|
||
- [ ] 手动验证步骤：
|
||
<!-- 描述如何复现验证；UI 改动请附截图 / 录屏 -->
|
||
|
||
## 回归风险
|
||
|
||
<!-- 影响面、可能受波及的功能、是否需要前后端 / 配置 同步部署 -->
|
||
|
||
## Checklist
|
||
|
||
- [ ] 分支命名遵循 [CONTRIBUTING.md §3](../CONTRIBUTING.md#3-分支命名)（`feature/*` / `fix/*` / `release/*` / `hotfix/*`）
|
||
- [ ] base 分支正确（常规改动 → `develop`；线上紧急 → `master`；发版 → 见 §4.3）
|
||
- [ ] Commit message 遵循 `type(scope): subject` 格式（[CONTRIBUTING.md §5.1](../CONTRIBUTING.md#51-commit-message-格式)）
|
||
- [ ] 已自测核心流程
|
||
- [ ] 已更新相关文档（`README.md` / `CHANGELOG.md` / `CLAUDE.md` / 模块 README，如适用）
|
||
- [ ] 未夹带 secrets / `.env` / 大型二进制
|
||
- [ ] 单 PR 不跨多个工作区做无关改动
|