关于 jackin-propose
jackin-propose 会将功能构想或问题整理为可跟踪的路线图草案,并创建早期 PR,不编写代码。它适用于需要纳入路线图的提案,并在设计和实现之前停止。
主要功能
- 01创建路线图条目草案
- 02将条目登记到路线图导航
- 03审查路线图条目
- 04提交、推送并创建早期 PR
- 05可选择纳入研究结果
适用场景
- 01提议纳入路线图跟踪的功能
- 02在设计前记录改进构想
- 03将研究结果整理进路线图草案
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ jackin-project/ jackin-dev --skill jackin-propose安装后在 Claude Code 中输入/jackin-propose确认已加载。
附带文件agents/openai.yaml
详细介绍
jackin-propose
将一项功能、改进或问题转化为受跟踪的路线图条目并创建一个早期 PR。此技能绝不编写代码——它会收集路线图条目所需的所有内容、创建 PR,然后停止。实施始终是之后单独进行的步骤(/goal Implement <slug>.md)。
jackin❯ 规则文件会自动加载——BRANCHING.md、COMMITS.md、PULL_REQUESTS.md、docs/ 规则、TODO.md(路线图约定)。此技能会按顺序执行这些规则。
适用场景
- 操作者运行
jackin-propose <idea or problem>。 - 值得加入路线图的功能或想法。
不适用场景
- 小型修复(拼写错误、依赖版本升级、单行改动)→
jackin-create-pr。 - 设计现有条目 →
jackin-brainstorm。实施现有条目 →/goal Implement <slug>.md。
参数
--branch <name>/--auto-branch— 指定 / 自动选择分支名称。--no-pr— 仅创建分支和路线图草稿,不创建 PR(少见;默认会创建 PR)。--research— 先运行deep-research,并将简短摘要纳入草稿。
流程
- 创建分支。 绝不直接提交到
main。根据想法生成feature/<slug>分支名(或根据改动类型使用fix//refactor//chore/);除非指定了--auto-branch/--branch,否则先提出名称并确认。 - (可选)研究。 使用
--research时,运行内置的deep-research技能,并将研究结果汇总到草稿中。对于大型研究,优先使用jackin-research。 - 搭建路线图条目。 运行
cargo xtask change new <slug> --group <group>— 此命令会创建docs/content/docs/roadmap/<slug>.mdx(包含**Status**: Open、## Problem、## Why It Matters、## Design、## Tasks、## Related Files),并将条目注册到所选分组的 Fumadocsmeta.json中。从现有路线图分组中选择--group。然后根据想法填写 Problem / Why It Matters,并运行cargo xtask roadmap audit。 - 提交并推送。 使用
docs:类型和 DCO-s,然后运行git push。 - 创建 PR。 除非指定
--no-pr,否则使用create-pr流程构建并创建 PR — Summary = 想法,What ships = "<slug>的路线图条目草稿",Verify = 文档渲染。 - 停止。 指引操作者进行下一步:运行
jackin-brainstorm <slug>填写## Design。不要实施。
常见错误
- 编写代码或填写
## Design/## Tasks— 这些属于brainstorm/plan/goal,绝不属于propose。 - 跳过侧边栏条目或审计,导致条目无法访问。
- 忘记创建早期 PR(这是默认操作 — 只有
--no-pr才会跳过)。
工具
cargo xtask change new <slug> --group <group> 会搭建 .mdx 并注册 Fumadocs meta.json 条目;cargo xtask roadmap audit 会验证侧边栏。
评论
支持 Markdown