Require preset-usage README with Spec Kit CLI syntax in preset submissions#3104
Open
mnriem wants to merge 1 commit into
Open
Require preset-usage README with Spec Kit CLI syntax in preset submissions#3104mnriem wants to merge 1 commit into
mnriem wants to merge 1 commit into
Conversation
Tighten the community preset submission workflow so it validates the README referenced by the documentation field rather than merely checking for a root README. The workflow now fails submissions whose linked README lacks a valid 'specify preset add ...' command and flags monorepo submissions that point documentation at a generic root README. - Add a required Documentation URL field to the preset issue template - Add validation step 2d (documentation README + CLI-syntax check) to .github/workflows/add-community-preset.md and recompile the lock file - Document the stricter usage-README requirement and reviewer content check in presets/PUBLISHING.md Closes github#3103 Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR hardens the community preset submission workflow by requiring submitters to provide a Documentation URL that points to the actual preset-usage README, and by documenting/enforcing that the linked README contains valid Spec Kit CLI install syntax (e.g., specify preset add ...). This addresses monorepo submissions that previously passed validation by linking to a generic repo-root README that wasn’t preset usage documentation.
Changes:
- Updated the
add-community-presetworkflow spec to validate the README at the submitteddocumentationURL and require aspecify preset add ...invocation (preferring--from <download-url>). - Extended the preset submission issue form to collect a required Documentation URL and add a submission requirement checkbox.
- Updated
presets/PUBLISHING.mdwith explicit “Usage README Requirements” and reviewer guidance for the residual content judgment.
Show a summary per file
| File | Description |
|---|---|
presets/PUBLISHING.md |
Documents the new requirement for preset-scoped usage READMEs and Spec Kit CLI install syntax; adds reviewer note about remaining human judgment. |
.github/workflows/add-community-preset.md |
Updates the workflow spec to validate the README referenced by documentation and require specify preset add ... usage. |
.github/workflows/add-community-preset.lock.yml |
Regenerated lockfile reflecting the workflow spec body change (hash update). |
.github/ISSUE_TEMPLATE/preset_submission.yml |
Adds a required documentation field and a checkbox reinforcing the linked-README + CLI-syntax requirement. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 4/4 changed files
- Comments generated: 3
Comment on lines
+152
to
+155
| The catalog `documentation` field must point at a README that explains how to use | ||
| **this preset** — not a product pitch for a broader framework or a separate CLI. The | ||
| submission workflow validates the linked README and **fails** submissions that don't | ||
| meet these requirements: |
Comment on lines
+179
to
+180
| A submission whose linked README lacks a valid `specify preset add ...` command is treated | ||
| as a generic description rather than usage documentation and will be flagged for changes. |
Comment on lines
+85
to
+88
| Link to the README that explains how to use **this preset** (not a general product/framework pitch). | ||
| Prefer the preset-scoped README (e.g. `presets/<id>/README.md` in a monorepo) over the repository root README. | ||
| It must contain at least one valid `specify preset ...` install command matching the Download URL above. | ||
| placeholder: "https://github.com/your-org/spec-kit-presets/blob/main/your-preset/README.md" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses #3103. The community preset submission workflow previously validated only that a
README.mdexists at the repository root, which passes trivially for monorepos even when the linkeddocumentationpoints at a product pitch rather than preset-usage docs.This PR tightens the workflow and docs to validate the README that
documentationactually points to, and requires a valid Spec Kit CLI install command.Changes
.github/workflows/add-community-preset.md— parse thedocumentationfield; new validation step 2d fetches the linked README (convertingblob→raw) and:specify preset add ...invocation (preferring--from <download-url>with an exact URL match),documentationpoints at a generic root README and recommends the preset-scoped one.Renumbered subsequent checks and recompiled
add-community-preset.lock.yml(only the body hash changed)..github/ISSUE_TEMPLATE/preset_submission.yml— required Documentation URL field + a new Submission Requirements checkbox.presets/PUBLISHING.md— a 'Usage README Requirements' section, updated prerequisites/checklist, and a reviewer note about the residual human content check.Acceptance criteria
documentation, not just root presencespecify preset ...invocationpresets/PUBLISHING.mdupdated to document the stricter requirementCloses #3103
🤖 Authored autonomously by GitHub Copilot (model: Claude Opus 4.8) on behalf of @mnriem.