jackin-propose

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

jackin-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-propose <idea or problem>
```
.
Feature/idea worth a roadmap item.

操作者执行
```
jackin-propose <创意或问题>
```
命令时。
功能/创意值得作为路线图项记录时。

When NOT to use

不适用场景

Small fix (typo, dep bump, one-liner) →
```
jackin-create-pr
```
.
Designing an existing item →
```
jackin-brainstorm
```
. Implementing one →
```
/goal Implement <slug>.md
```
.

小型修复（拼写错误、依赖版本更新、单行代码修改）→ 使用
```
jackin-create-pr
```
。
为已有项设计方案 → 使用
```
jackin-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-research
```
。

Process

流程

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.
(optional) Research. On
```
--research
```
, run the built-in
```
deep-research
```
skill and summarize findings into the draft. For large research, prefer
```
jackin-research
```
.
Scaffold the roadmap item. Run
```
cargo xtask change new <slug> --group <group>
```
— it creates
```
docs/content/docs/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
```
.
Commit + push.
```
docs:
```
type, DCO
```
-s
```
, then
```
git push
```
.
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.
Stop. Point the operator at the next step:
```
jackin-brainstorm <slug>
```
to fill
```
## Design
```
. Do not implement.

创建分支。绝不直接提交到
```
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
```
文件（包含
```
**状态**: 开放
```
、
```
## 问题
```
、
```
## 重要性
```
、
```
## 设计方案
```
、
```
## 任务
```
、
```
## 相关文件
```
等模块），并在所选分组的Fumadocs
```
meta.json
```
中注册该项。从现有路线图分组中选择
```
--group
```
参数值。然后根据创意文本填充
```
问题
```
/
```
重要性
```
模块，再执行
```
cargo xtask roadmap audit
```
。
提交并推送。提交类型为
```
docs:
```
，添加DCO
```
-s
```
签名，然后执行
```
git push
```
。
创建PR。除非使用
```
--no-pr
```
参数，否则按照
```
create-pr
```
的机制生成并打开PR——摘要为创意内容，交付内容为“
```
<slug>
```
的路线图项草稿”，验证项为文档渲染效果。
停止操作。提示操作者执行下一步：使用
```
jackin-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（这是默认行为——仅
```
--no-pr
```
会跳过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

用于验证侧边栏配置。