Skip to content

docs(presets): add lean preset README and enrich catalog metadata#2340

Merged
mnriem merged 2 commits intogithub:mainfrom
mnriem:feat/lean-preset-metadata-and-readme
Apr 24, 2026
Merged

docs(presets): add lean preset README and enrich catalog metadata#2340
mnriem merged 2 commits intogithub:mainfrom
mnriem:feat/lean-preset-metadata-and-readme

Conversation

@mnriem
Copy link
Copy Markdown
Collaborator

@mnriem mnriem commented Apr 23, 2026

Adds documentation and metadata improvements for the bundled lean preset:

  • presets/lean/README.md — New README documenting the lean workflow preset, its commands, when to use it, and development instructions.
  • presets/catalog.json — Adds license, requires.speckit_version, and provides.commands fields to the lean preset entry.
  • presets/lean/preset.yml — Adds "core" tag for discoverability.

- Add README.md documenting the lean workflow preset, its commands,
  when to use it, and development instructions.
- Add license, requires.speckit_version, and provides.commands fields
  to the lean preset catalog entry.
- Add "core" tag to preset.yml for discoverability.
Copilot AI review requested due to automatic review settings April 23, 2026 20:48
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation and richer catalog metadata for the bundled lean preset to improve discoverability and clarify usage within the Spec Kit preset ecosystem.

Changes:

  • Adds a new presets/lean/README.md describing the Lean workflow and usage/development commands.
  • Enriches presets/catalog.json with license, Spec Kit version requirement, and “provides” metadata for the lean entry.
  • Adds a "core" tag to the lean preset manifest for better discoverability.
Show a summary per file
File Description
presets/lean/preset.yml Adds "core" to the preset’s tag list.
presets/lean/README.md Introduces Lean preset documentation (usage, commands, dev workflow, license).
presets/catalog.json Adds license/requirements/provides metadata to the official lean catalog entry.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comments suppressed due to low confidence (2)

presets/lean/README.md:17

  • The “Output” column suggests files are written to the repo root (e.g., spec.md), but the lean command templates write artifacts under the selected <feature_directory>/ (see presets/lean/commands/speckit.*.md). Update the outputs here to reflect the actual paths so users aren’t confused.
| `speckit.specify` | `spec.md` | Create a specification from a feature description |
| `speckit.plan` | `plan.md` | Create an implementation plan from the spec |
| `speckit.tasks` | `tasks.md` | Create dependency-ordered tasks from spec and plan |
| `speckit.implement` | *(code)* | Execute all tasks in order, marking progress |
| `speckit.constitution` | `constitution.md` | Create or update the project constitution |

presets/lean/README.md:21

  • This says “no separate template files involved”, but the preset provides command templates from presets/lean/commands/speckit.*.md. Consider rephrasing to clarify that Lean replaces the core workflow commands with leaner command templates (rather than implying there are no template files).
Lean overrides the five core workflow commands with self-contained prompts that produce each artifact directly — no separate template files involved. The result is a shorter, more direct workflow.
  • Files reviewed: 3/3 changed files
  • Comments generated: 3

Comment thread presets/catalog.json
Comment thread presets/catalog.json Outdated
Comment thread presets/lean/README.md
Address PR review feedback:
- Bump updated_at to reflect catalog modification time
- Add provides.templates (0) to lean preset entry for consistency
  with catalog schema used in catalog.community.json
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 3/3 changed files
  • Comments generated: 0 new

@mnriem mnriem merged commit 8750e94 into github:main Apr 24, 2026
15 checks passed
@mnriem mnriem deleted the feat/lean-preset-metadata-and-readme branch April 24, 2026 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants