mcpField
P
propose

propose

github.com/jackin-project开发3160 次安装5 周前更新
代码仓库

关于 propose

propose 是 jackin' 的开发技能,可将想法整理为路线图条目并提交早期 PR。它负责创建和登记草稿,但不编写代码或补全设计。

主要功能

  1. 01创建路线图条目框架
  2. 02登记 Fumadocs 侧边栏条目
  3. 03运行路线图审计
  4. 04可选加入 deep-research 摘要
  5. 05可选创建 PR

适用场景

  1. 01在路线图中跟踪功能想法
  2. 02起草改进提案以供评审
  3. 03在实施前记录待解决的问题

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/jackin-project/jackin-dev --skill propose

安装后在 Claude Code 中输入/propose确认已加载。

详细介绍

提议

将一项功能、改进或问题转化为已跟踪的路线图条目,并创建早期 PR。此技能绝不编写代码——它会收集路线图条目的所有内容、创建 PR,然后停止。实现始终是之后单独进行的步骤(/goal Implement <slug>.md)。

jackin' 规则文件会自动加载——BRANCHING.md、COMMITS.md、PULL_REQUESTS.md、docs/ 规则、TODO.md(路线图约定)。此技能会按顺序执行这些规则。

适用场景

  • 操作者运行 /jackin-dev:propose <idea or problem>。
  • 值得纳入路线图的功能或想法。

不适用场景

  • 小修复(拼写错误、依赖版本升级、一行改动)→ /jackin-dev:create-pr。
  • 设计现有条目 → /jackin-dev:brainstorm。实现现有条目 → /goal Implement <slug>.md。

参数

  • --branch <name> / --auto-branch — 显式指定 / 自行选择分支名称。
  • --no-pr — 仅创建分支和路线图草稿,不创建 PR(少见;默认会创建 PR)。
  • --research — 先运行 deep-research,并将简短摘要纳入草稿。

流程

  1. 创建分支。 切勿提交到 main。根据想法派生 feature/<slug> 名称(或根据改动类型使用 fix/ / refactor/ / chore/);除非给定 --auto-branch / --branch,否则先提出分支名并确认。
  2. (可选)研究。 使用 --research 时,运行内置的 deep-research 技能,并将研究结果总结到草稿中。对于大型研究,优先使用 /jackin-dev:research。
  3. 搭建路线图条目框架。 运行 cargo xtask change new <slug> --group <group> — 此命令会创建 docs/content/docs/roadmap/<slug>.mdx(包含 **Status**: Open、## Problem、## Why It Matters、## Design、## Tasks、## Related Files),并将其登记到所选分组的 Fumadocs meta.json 中。从现有路线图分组中选择 --group。然后根据想法填写 Problem / Why It Matters,并运行 cargo xtask roadmap audit。
  4. 提交并推送。 使用 docs: 类型和 DCO -s,然后运行 git push。
  5. 创建 PR。 除非使用 --no-pr,否则使用 create-pr 的机制创建并打开 PR — Summary = 想法,What ships = "<slug> 的路线图条目草稿",Verify = 文档渲染。
  6. 停止。 告知操作者下一步:运行 /jackin-dev: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