mcpField
P
propose

propose

github.com/jackin-projectDevelopment3160 installsUpdated 5w ago
Repository

About propose

propose is a jackin' development skill for turning an idea into a tracked roadmap item and an early PR. It scaffolds and registers the draft, but does not write code or complete its design.

Key features

  1. 01Roadmap item scaffolding
  2. 02Fumadocs sidebar registration
  3. 03Roadmap audit
  4. 04Optional deep-research summary
  5. 05Optional PR creation

Use cases

  1. 01Tracking a feature idea on the roadmap
  2. 02Drafting an improvement proposal for review
  3. 03Recording an issue before implementation

Install

Copy the command and run it in a terminal.

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

After installing, type/proposein Claude Code to confirm it loaded.

Details

From the project README

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.

When to use

  • Operator runs /jackin-dev:propose <idea or problem>.
  • Feature/idea worth a roadmap item.

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.

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.

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/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.

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).

Tooling

cargo xtask change new <slug> --group <group> scaffolds the .mdx + registers the Fumadocs meta.json entry; cargo xtask roadmap audit validates the sidebar.

Comments

Markdown supported