Skip to content

chore: 补齐 CHANGELOG / CONTRIBUTING / issue 模板,清理占位图 - #3

Merged
BUGJI merged 1 commit into
mainfrom
chore/repo-hygiene
Sep 23, 2026
Merged

BUGJI merged 1 commit into
mainfrom
chore/repo-hygiene

Conversation

@BUGJI

@BUGJI BUGJI commented Sep 23, 2026

Copy link
Copy Markdown
Owner

做了什么

补齐开源仓库的“外围”文件,让第一次来的人知道怎么看变更、怎么提 PR、怎么报 bug:

  • CHANGELOG.md:从 0.1.0 反推到 0.2.14,每条带 compare 链接(口语化的原说明压缩成条目,未改事实)
  • CONTRIBUTING.md:环境要求与开发命令、Biome + Prettier 的分工、测试与提交流程、PR 约定、插件归口到组织的约定,以及发布流程 —— 其中约定今后新版本要写中英双语 release notes(只约束今后,不回溯改历史 release)
  • .github/ISSUE_TEMPLATE/bug_report.yml、feature_request.yml、config.yml(引导先搜 issue、附版本号与日志路径)
  • .github/PULL_REQUEST_TEMPLATE.md
  • README 中英:链接 CHANGELOG.md、新增「参与贡献」小节、许可小节补上第三方组件许可表
  • 删除 docs/images/ 下 3 张占位图(已被你换上的真实截图取代)

提示

package-lock.json 根 version 仍是 0.2.13(package.json 已是 0.2.14),下次 npm install 会自动同步。

- 新增 CHANGELOG.md:按版本汇总 0.1.0 → 0.2.14 的主要变更(含 compare 链接),完整原文仍指向 Releases
- 新增 CONTRIBUTING.md:开发环境、代码风格、测试、分支与提交约定、PR 要求、插件贡献、发布流程
  (发布流程含「双语 release notes」要求,后续新版本请附 English summary)
- 新增 .github/ISSUE_TEMPLATE(bug / feature 表单 + config 联系方式)与 PULL_REQUEST_TEMPLATE.md
- README(中英):下载小节链接 CHANGELOG,新增「参与贡献」小节,许可小节补充第三方组件许可表
  (许可标识取自各依赖在 npm 上的声明)
- 移除已被真实截图替换的 docs/images/ 三张占位图
@BUGJI
BUGJI merged commit bc635b5 into main Sep 23, 2026
2 checks passed
@BUGJI
BUGJI deleted the chore/repo-hygiene branch September 23, 2026 01:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant