openspec-onboard

Guide developers through OpenSpec workflow cycles creating change artifacts.

5|Updated Sep 17, 2022
One-click install
npx skills add https://github.com/kevinxo328/mercari-scraper --skill openspec-onboard-kevinxo328
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: openspec-onboard
Source: https://github.com/kevinxo328/mercari-scraper/tree/main/.gemini/skills/openspec-onboard
Command: npx skills add https://github.com/kevinxo328/mercari-scraper --skill openspec-onboard-kevinxo328

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill teaches developers how to run a full OpenSpec workflow end-to-end so small, real code changes are planned, implemented, and archived with clear decision records.

Core Features & Use Cases

  • Guided Onboarding: Step-by-step narration that walks through selecting a task, exploring code, creating a change, drafting proposal/specs/design, implementing tasks, and archiving the result.
  • Artifact Creation: Produces and persists proposal.md, design.md, specs, and tasks within openspec/changes/<name>/ to make decisions discoverable.
  • CLI-driven Workflow: Uses the OpenSpec CLI to create and manage change containers and integrates with local git history for context.
  • Use Case: Ideal for developers or teams learning the OpenSpec rhythm by performing a small, contained repository change.

Quick Start

Run the OpenSpec CLI to create a new change for a small task in your repository and follow the guided prompts to propose, spec, design, implement, and archive it.

Frequently Asked Questions about openspec-onboard

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I manage small codebase changes with a structured spec workflow?

A structured spec workflow manages small codebase changes by guiding you through proposing, drafting specs, designing, implementing, and archiving changes. This ensures atomic modifications are planned and recorded with clear decision artifacts.

What is the OpenSpec change cycle for repository change management?

The OpenSpec change cycle is an end-to-end workflow for repository change management that creates and manages change artifacts. It walks developers through proposing, drafting specs, designing, implementing tasks, and archiving results within a codebase.

Do I need the OpenSpec CLI to create and archive change directories?

Yes, the OpenSpec CLI is required to create and archive change directories. The CLI drives the workflow by generating change containers and persisting proposal, design, spec, and task artifacts within the repository.

How to persist proposal and design artifacts for codebase changes?

To persist proposal and design artifacts for codebase changes, use the OpenSpec CLI to create a change directory. The workflow produces and saves proposal.md, design.md, specs, and tasks within openspec/changes/<name>/ to make decisions discoverable.

Can I use OpenSpec onboarding for small atomic changes in a git repository?

Yes, OpenSpec onboarding is ideal for developers working on small, atomic changes in a git repository. It integrates with local git history for context and guides you through a contained repository change from proposal to archive.

Why does my team need change artifacts persisted in the codebase?

Persisting change artifacts in the codebase makes decision records discoverable and ensures real code changes are planned. It creates a clear history of proposals, specs, designs, and tasks for maintainers reviewing repository modifications.