From f85944aafe32848c1e9db32d763a0309a6aa5f97 Mon Sep 17 00:00:00 2001 From: Manfred Riem <15701806+mnriem@users.noreply.github.com> Date: Thu, 19 Mar 2026 11:57:32 -0500 Subject: [PATCH] docs: update SUPPORT.md, fix issue templates, add preset submission template (#1910) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: update SUPPORT.md, fix issue templates, add preset submission template - SUPPORT.md: simplify structure, add Discussions link, soften response commitment - config.yml: fix broken Extension Development Guide URL (was manfredseee → github) - agent_request.yml: update agent list with Tabnine, Vibe, Kimi, Trae, Pi, iFlow - preset_submission.yml: new issue template for preset catalog submissions * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/agent_request.yml | 2 +- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/preset_submission.yml | 169 +++++++++++++++++++ SUPPORT.md | 13 +- 4 files changed, 177 insertions(+), 9 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/preset_submission.yml diff --git a/.github/ISSUE_TEMPLATE/agent_request.yml b/.github/ISSUE_TEMPLATE/agent_request.yml index a6ac6c4b..37b0fea5 100644 --- a/.github/ISSUE_TEMPLATE/agent_request.yml +++ b/.github/ISSUE_TEMPLATE/agent_request.yml @@ -8,7 +8,7 @@ body: value: | Thanks for requesting a new agent! Before submitting, please check if the agent is already supported. - **Currently supported agents**: Claude Code, Gemini CLI, GitHub Copilot, Cursor, Qwen Code, opencode, Codex CLI, Windsurf, Kilo Code, Auggie CLI, Roo Code, CodeBuddy, Qoder CLI, Kiro CLI, Amp, SHAI, IBM Bob, Antigravity + **Currently supported agents**: Claude Code, Gemini CLI, GitHub Copilot, Cursor, Qwen Code, opencode, Codex CLI, Windsurf, Kilo Code, Auggie CLI, Roo Code, CodeBuddy, Qoder CLI, Kiro CLI, Amp, SHAI, Tabnine CLI, Antigravity, IBM Bob, Mistral Vibe, Kimi Code, Trae, Pi Coding Agent, iFlow CLI - type: input id: agent-name diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c352f862..04d1923b 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -7,7 +7,7 @@ contact_links: url: https://github.com/github/spec-kit/blob/main/README.md about: Read the Spec Kit documentation and guides - name: 🛠️ Extension Development Guide - url: https://github.com/manfredseee/spec-kit/blob/main/extensions/EXTENSION-DEVELOPMENT-GUIDE.md + url: https://github.com/github/spec-kit/blob/main/extensions/EXTENSION-DEVELOPMENT-GUIDE.md about: Learn how to develop and publish Spec Kit extensions - name: 🤝 Contributing Guide url: https://github.com/github/spec-kit/blob/main/CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/preset_submission.yml b/.github/ISSUE_TEMPLATE/preset_submission.yml new file mode 100644 index 00000000..3a1b9634 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/preset_submission.yml @@ -0,0 +1,169 @@ +name: Preset Submission +description: Submit your preset to the Spec Kit preset catalog +title: "[Preset]: Add " +labels: ["preset-submission", "enhancement", "needs-triage"] +body: + - type: markdown + attributes: + value: | + Thanks for contributing a preset! This template helps you submit your preset to the community catalog. + + **Before submitting:** + - Review the [Preset Publishing Guide](https://github.com/github/spec-kit/blob/main/presets/PUBLISHING.md) + - Ensure your preset has a valid `preset.yml` manifest + - Create a GitHub release with a version tag (e.g., v1.0.0) + - Test installation from the release archive: `specify preset add --from ` + + - type: input + id: preset-id + attributes: + label: Preset ID + description: Unique preset identifier (lowercase with hyphens only) + placeholder: "e.g., healthcare-compliance" + validations: + required: true + + - type: input + id: preset-name + attributes: + label: Preset Name + description: Human-readable preset name + placeholder: "e.g., Healthcare Compliance" + validations: + required: true + + - type: input + id: version + attributes: + label: Version + description: Semantic version number + placeholder: "e.g., 1.0.0" + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: Brief description of what your preset does (under 200 characters) + placeholder: Enforces HIPAA-compliant spec workflows with audit templates and compliance checklists + validations: + required: true + + - type: input + id: author + attributes: + label: Author + description: Your name or organization + placeholder: "e.g., John Doe or Acme Corp" + validations: + required: true + + - type: input + id: repository + attributes: + label: Repository URL + description: GitHub repository URL for your preset + placeholder: "https://github.com/your-org/spec-kit-your-preset" + validations: + required: true + + - type: input + id: download-url + attributes: + label: Download URL + description: URL to the GitHub release archive for your preset (e.g., https://github.com/your-org/spec-kit-preset-your-preset/archive/refs/tags/v1.0.0.zip) + placeholder: "https://github.com/your-org/spec-kit-preset-your-preset/archive/refs/tags/v1.0.0.zip" + validations: + required: true + + - type: input + id: license + attributes: + label: License + description: Open source license type + placeholder: "e.g., MIT, Apache-2.0" + validations: + required: true + + - type: input + id: speckit-version + attributes: + label: Required Spec Kit Version + description: Minimum Spec Kit version required + placeholder: "e.g., >=0.3.0" + validations: + required: true + + - type: textarea + id: templates-provided + attributes: + label: Templates Provided + description: List the template overrides your preset provides + placeholder: | + - spec-template.md — adds compliance section + - plan-template.md — includes audit checkpoints + - checklist-template.md — HIPAA compliance checklist + validations: + required: true + + - type: textarea + id: commands-provided + attributes: + label: Commands Provided (optional) + description: List any command overrides your preset provides + placeholder: | + - speckit.specify.md — customized for compliance workflows + + - type: textarea + id: tags + attributes: + label: Tags + description: 2-5 relevant tags (lowercase, separated by commas) + placeholder: "compliance, healthcare, hipaa, audit" + validations: + required: true + + - type: textarea + id: features + attributes: + label: Key Features + description: List the main features and capabilities of your preset + placeholder: | + - HIPAA-compliant spec templates + - Audit trail checklists + - Compliance review workflow + validations: + required: true + + - type: checkboxes + id: testing + attributes: + label: Testing Checklist + description: Confirm that your preset has been tested + options: + - label: Preset installs successfully via `specify preset add` + required: true + - label: Template resolution works correctly after installation + required: true + - label: Documentation is complete and accurate + required: true + - label: Tested on at least one real project + required: true + + - type: checkboxes + id: requirements + attributes: + label: Submission Requirements + description: Verify your preset meets all requirements + options: + - label: Valid `preset.yml` manifest included + required: true + - label: README.md with description and usage instructions + required: true + - label: LICENSE file included + required: true + - label: GitHub release created with version tag + required: true + - label: Preset ID follows naming conventions (lowercase-with-hyphens) + required: true diff --git a/SUPPORT.md b/SUPPORT.md index c6acf76e..308abae9 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -1,18 +1,17 @@ # Support -## How to file issues and get help +## How to get help -This project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue. +Please search existing [issues](https://github.com/github/spec-kit/issues) and [discussions](https://github.com/github/spec-kit/discussions) before creating new ones to avoid duplicates. -For help or questions about using this project, please: - -- Open a [GitHub issue](https://github.com/github/spec-kit/issues/new) for bug reports, feature requests, or questions about the Spec-Driven Development methodology -- Check the [comprehensive guide](./spec-driven.md) for detailed documentation on the Spec-Driven Development process - Review the [README](./README.md) for getting started instructions and troubleshooting tips +- Check the [comprehensive guide](./spec-driven.md) for detailed documentation on the Spec-Driven Development process +- Ask in [GitHub Discussions](https://github.com/github/spec-kit/discussions) for questions about using Spec Kit or the Spec-Driven Development methodology +- Open a [GitHub issue](https://github.com/github/spec-kit/issues/new) for bug reports and feature requests ## Project Status -**Spec Kit** is under active development and maintained by GitHub staff **AND THE COMMUNITY**. We will do our best to respond to support, feature requests, and community questions in a timely manner. +**Spec Kit** is under active development and maintained by GitHub staff and the community. We will do our best to respond to support, feature requests, and community questions as time permits. ## GitHub Support Policy