propose

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

propose

propose

Turn a feature, improvement, or problem into a tracked roadmap item and an early PR. This skill never writes code — it collects everything for the roadmap item, opens the PR, and stops. Implementation is always a separate later step (
/goal Implement <slug>.md
).
jackin' rule files auto-load —
BRANCHING.md
,
COMMITS.md
,
PULL_REQUESTS.md
,
docs/
rules,
TODO.md
(roadmap conventions). This skill sequences them.
将功能、改进方案或问题转化为可追踪的路线图项和早期PR。此技能绝不编写代码——它仅为路线图项收集所有必要信息、创建PR后即停止。具体实现始终是后续独立步骤(执行
/goal Implement <slug>.md
命令)。
jackin'规则文件会自动加载——包括
BRANCHING.md
COMMITS.md
PULL_REQUESTS.md
docs/
目录下的规则以及
TODO.md
(路线图约定)。此技能会按顺序执行这些规则。

When to use

使用场景

  • Operator runs
    /jackin-dev:propose <idea or problem>
    .
  • Feature/idea worth a roadmap item.
  • 操作者执行
    /jackin-dev:propose <idea or problem>
    命令时。
  • 功能/想法值得创建为路线图项时。

When NOT to use

不适用场景

  • Small fix (typo, dep bump, one-liner) →
    /jackin-dev:create-pr
    .
  • Designing an existing item →
    /jackin-dev:brainstorm
    . Implementing one →
    /goal Implement <slug>.md
    .
  • 小修复(拼写错误、依赖版本更新、单行代码修改)→ 使用
    /jackin-dev:create-pr
    命令。
  • 为已有项设计方案→ 使用
    /jackin-dev:brainstorm
    命令。为已有项实现功能→ 使用
    /goal Implement <slug>.md
    命令。

Arguments

参数

  • --branch <name>
    /
    --auto-branch
    — explicit / self-chosen branch name.
  • --no-pr
    — branch + roadmap draft only, no PR (rare; default opens a PR).
  • --research
    — run
    deep-research
    first and fold a short summary into the draft.
  • --branch <name>
    /
    --auto-branch
    — 指定分支名称 / 自动生成分支名称。
  • --no-pr
    — 仅创建分支和路线图草稿,不生成PR(少见;默认会创建PR)。
  • --research
    — 先执行
    deep-research
    技能,并将简短研究摘要纳入草稿。若需大量研究,建议使用
    /jackin-dev:research
    命令。

Process

流程

  1. Branch. Never commit to
    main
    . Derive a
    feature/<slug>
    name (or
    fix/
    /
    refactor/
    /
    chore/
    per change type) from the idea; suggest and confirm unless
    --auto-branch
    /
    --branch
    given.
  2. (optional) Research. On
    --research
    , run the built-in
    deep-research
    skill and summarize findings into the draft. For large research, prefer
    /jackin-dev:research
    .
  3. Scaffold the roadmap item. Run
    cargo xtask change new <slug> --group <group>
    — it creates
    docs/content/docs/reference/roadmap/<slug>.mdx
    (
    **Status**: Open
    ,
    ## Problem
    ,
    ## Why It Matters
    ,
    ## Design
    ,
    ## Tasks
    ,
    ## Related Files
    ) and registers it in the chosen group's Fumadocs
    meta.json
    . Pick the
    --group
    from the existing roadmap groups. Then fill Problem / Why It Matters from the idea text, and run
    cargo xtask roadmap audit
    .
  4. Commit + push.
    docs:
    type, DCO
    -s
    , then
    git push
    .
  5. Open the PR. Unless
    --no-pr
    , build and open the PR with
    create-pr
    mechanics — Summary = the idea, What ships = "roadmap item draft for
    <slug>
    ", Verify = docs render.
  6. Stop. Point the operator at the next step:
    /jackin-dev:brainstorm <slug>
    to fill
    ## Design
    . Do not implement.
  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/reference/roadmap/<slug>.mdx
    文件(包含
    **状态**: 开放
    ## 问题
    ## 重要性
    ## 设计方案
    ## 任务
    ## 相关文件
    等板块),并在所选分组的Fumadocs
    meta.json
    中注册该项。从现有路线图分组中选择
    --group
    参数值。然后根据想法文本填充「问题」和「重要性」板块,再执行
    cargo xtask roadmap audit
    命令。
  4. 提交并推送:提交类型为
    docs:
    ,添加DCO
    -s
    签名,然后执行
    git push
  5. 创建PR:除非指定
    --no-pr
    参数,否则按照
    create-pr
    的机制生成并打开PR——摘要为想法内容,交付内容为“
    <slug>
    的路线图项草稿”,验证项为文档渲染情况。
  6. 停止操作:告知操作者下一步操作:执行
    /jackin-dev:brainstorm <slug>
    命令以填充「设计方案」板块。请勿进行实现工作。

Common mistakes

常见错误

  • Writing code or filling
    ## Design
    /
    ## Tasks
    — those belong to
    brainstorm
    /
    plan
    /
    goal
    , never
    propose
    .
  • Skipping the sidebar entry or audit, leaving the item unreachable.
  • Forgetting the early PR (it is the default — only
    --no-pr
    skips it).
  • 编写代码或填充「设计方案」/「任务」板块——这些属于
    brainstorm
    /
    plan
    /
    goal
    技能的工作范围,绝不可在
    propose
    中完成。
  • 跳过侧边栏条目注册或审计步骤,导致路线图项无法被访问。
  • 忘记创建早期PR(默认会创建PR,仅
    --no-pr
    参数会跳过此步骤)。

Tooling

工具说明

cargo xtask change new <slug> --group <group>
scaffolds the
.mdx
+ registers the Fumadocs
meta.json
entry;
cargo xtask roadmap audit
validates the sidebar.
cargo xtask change new <slug> --group <group>
命令用于生成
.mdx
文件并在Fumadocs的
meta.json
中注册条目;
cargo xtask roadmap audit
命令用于验证侧边栏配置。