|
| 1 | +name: Preset Submission |
| 2 | +description: Submit your preset to the Spec Kit preset catalog |
| 3 | +title: "[Preset]: Add " |
| 4 | +labels: ["preset-submission", "enhancement", "needs-triage"] |
| 5 | +body: |
| 6 | + - type: markdown |
| 7 | + attributes: |
| 8 | + value: | |
| 9 | + Thanks for contributing a preset! This template helps you submit your preset to the community catalog. |
| 10 | + |
| 11 | + **Before submitting:** |
| 12 | + - Review the [Preset Publishing Guide](https://github.com/github/spec-kit/blob/main/presets/PUBLISHING.md) |
| 13 | + - Ensure your preset has a valid `preset.yml` manifest |
| 14 | + - Create a GitHub release with a version tag (e.g., v1.0.0) |
| 15 | + - Test installation from the release archive: `specify preset add --from <download-url>` |
| 16 | +
|
| 17 | + - type: input |
| 18 | + id: preset-id |
| 19 | + attributes: |
| 20 | + label: Preset ID |
| 21 | + description: Unique preset identifier (lowercase with hyphens only) |
| 22 | + placeholder: "e.g., healthcare-compliance" |
| 23 | + validations: |
| 24 | + required: true |
| 25 | + |
| 26 | + - type: input |
| 27 | + id: preset-name |
| 28 | + attributes: |
| 29 | + label: Preset Name |
| 30 | + description: Human-readable preset name |
| 31 | + placeholder: "e.g., Healthcare Compliance" |
| 32 | + validations: |
| 33 | + required: true |
| 34 | + |
| 35 | + - type: input |
| 36 | + id: version |
| 37 | + attributes: |
| 38 | + label: Version |
| 39 | + description: Semantic version number |
| 40 | + placeholder: "e.g., 1.0.0" |
| 41 | + validations: |
| 42 | + required: true |
| 43 | + |
| 44 | + - type: textarea |
| 45 | + id: description |
| 46 | + attributes: |
| 47 | + label: Description |
| 48 | + description: Brief description of what your preset does (under 200 characters) |
| 49 | + placeholder: Enforces HIPAA-compliant spec workflows with audit templates and compliance checklists |
| 50 | + validations: |
| 51 | + required: true |
| 52 | + |
| 53 | + - type: input |
| 54 | + id: author |
| 55 | + attributes: |
| 56 | + label: Author |
| 57 | + description: Your name or organization |
| 58 | + placeholder: "e.g., John Doe or Acme Corp" |
| 59 | + validations: |
| 60 | + required: true |
| 61 | + |
| 62 | + - type: input |
| 63 | + id: repository |
| 64 | + attributes: |
| 65 | + label: Repository URL |
| 66 | + description: GitHub repository URL for your preset |
| 67 | + placeholder: "https://github.com/your-org/spec-kit-your-preset" |
| 68 | + validations: |
| 69 | + required: true |
| 70 | + |
| 71 | + - type: input |
| 72 | + id: download-url |
| 73 | + attributes: |
| 74 | + label: Download URL |
| 75 | + 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) |
| 76 | + placeholder: "https://github.com/your-org/spec-kit-preset-your-preset/archive/refs/tags/v1.0.0.zip" |
| 77 | + validations: |
| 78 | + required: true |
| 79 | + |
| 80 | + - type: input |
| 81 | + id: license |
| 82 | + attributes: |
| 83 | + label: License |
| 84 | + description: Open source license type |
| 85 | + placeholder: "e.g., MIT, Apache-2.0" |
| 86 | + validations: |
| 87 | + required: true |
| 88 | + |
| 89 | + - type: input |
| 90 | + id: speckit-version |
| 91 | + attributes: |
| 92 | + label: Required Spec Kit Version |
| 93 | + description: Minimum Spec Kit version required |
| 94 | + placeholder: "e.g., >=0.3.0" |
| 95 | + validations: |
| 96 | + required: true |
| 97 | + |
| 98 | + - type: textarea |
| 99 | + id: templates-provided |
| 100 | + attributes: |
| 101 | + label: Templates Provided |
| 102 | + description: List the template overrides your preset provides |
| 103 | + placeholder: | |
| 104 | + - spec-template.md — adds compliance section |
| 105 | + - plan-template.md — includes audit checkpoints |
| 106 | + - checklist-template.md — HIPAA compliance checklist |
| 107 | + validations: |
| 108 | + required: true |
| 109 | + |
| 110 | + - type: textarea |
| 111 | + id: commands-provided |
| 112 | + attributes: |
| 113 | + label: Commands Provided (optional) |
| 114 | + description: List any command overrides your preset provides |
| 115 | + placeholder: | |
| 116 | + - speckit.specify.md — customized for compliance workflows |
| 117 | +
|
| 118 | + - type: textarea |
| 119 | + id: tags |
| 120 | + attributes: |
| 121 | + label: Tags |
| 122 | + description: 2-5 relevant tags (lowercase, separated by commas) |
| 123 | + placeholder: "compliance, healthcare, hipaa, audit" |
| 124 | + validations: |
| 125 | + required: true |
| 126 | + |
| 127 | + - type: textarea |
| 128 | + id: features |
| 129 | + attributes: |
| 130 | + label: Key Features |
| 131 | + description: List the main features and capabilities of your preset |
| 132 | + placeholder: | |
| 133 | + - HIPAA-compliant spec templates |
| 134 | + - Audit trail checklists |
| 135 | + - Compliance review workflow |
| 136 | + validations: |
| 137 | + required: true |
| 138 | + |
| 139 | + - type: checkboxes |
| 140 | + id: testing |
| 141 | + attributes: |
| 142 | + label: Testing Checklist |
| 143 | + description: Confirm that your preset has been tested |
| 144 | + options: |
| 145 | + - label: Preset installs successfully via `specify preset add` |
| 146 | + required: true |
| 147 | + - label: Template resolution works correctly after installation |
| 148 | + required: true |
| 149 | + - label: Documentation is complete and accurate |
| 150 | + required: true |
| 151 | + - label: Tested on at least one real project |
| 152 | + required: true |
| 153 | + |
| 154 | + - type: checkboxes |
| 155 | + id: requirements |
| 156 | + attributes: |
| 157 | + label: Submission Requirements |
| 158 | + description: Verify your preset meets all requirements |
| 159 | + options: |
| 160 | + - label: Valid `preset.yml` manifest included |
| 161 | + required: true |
| 162 | + - label: README.md with description and usage instructions |
| 163 | + required: true |
| 164 | + - label: LICENSE file included |
| 165 | + required: true |
| 166 | + - label: GitHub release created with version tag |
| 167 | + required: true |
| 168 | + - label: Preset ID follows naming conventions (lowercase-with-hyphens) |
| 169 | + required: true |
0 commit comments