SuperAPI AI 工具集

changelog

通用与其它

查看项目

更新于 10-16 05:07

技能介绍

用途:为 inbox-zero 项目添加面向用户的更新日志条目。条目以独立文件形式存放在 docs/changelog-entries/ 目录,随后需重新生成 docs/changelog.mdx,再提交或更新 PR。

主要能力与写作原则:只写用户可见的变化,不写基础设施、CI、安全加固、计费内部、队列修复、cron 变更、自托管或开发者专属内容。每条以主题名作为标题(写在 description 字段,如“Chat Everywhere”,而非版本号),用一段简短文字说明核心功能及其意义,面向终端用户而非开发者;其他改进最多 3–5 条要点,不足 3 条则并入下一条有强主题的条目;没有突出功能的发布可跳过;语气随意清晰,用“你/你的”,不用行话。

格式:创建或更新 docs/changelog-entries/YYYY-MM-DD.mdx,包含 frontmatter(description 为主题名)与 markdown 正文,日期由文件名自动推导。不要手动编辑 docs/changelog.mdx,需用 node docs/scripts/build-changelog.mjs 重新生成。

流程:用 gh pr list --repo elie222/inbox-zero --state merged --limit 30 --json number,title,mergedAt 查看近期合并 PR,筛选用户可见变化并归纳主题;用 gh pr list --repo elie222/inbox-zero --head automation/changelog --base main --state open --json number,title,url 检查是否已有开放的 changelog PR;若当天文件已存在则合并更新而非新建第二条;提交 docs/changelog-entries/YYYY-MM-DD.mdx 与 docs/changelog.mdx 两个文件。

分支工作流:改动前先重置自动化分支到最新 main:git fetch origin 与 git checkout -B automation/changelog origin/main;更新文件后推送该分支,并从 automation/changelog 向 main 创建或更新 PR,尽量复用同一长期分支,避免并发多个 changelog PR。

限制:仅适用于该仓库的更新日志流程;具体命令与路径以资料为准,其他细节暂未提供。