Skip to content

docs: add Spec issue template#1574

Merged
leshy merged 1 commit intodevfrom
docs/spec-template
Mar 16, 2026
Merged

docs: add Spec issue template#1574
leshy merged 1 commit intodevfrom
docs/spec-template

Conversation

@spomichter
Copy link
Contributor

Adds a Spec category to GitHub issue templates — single markdown text box for technical specifications.

Contributor License Agreement

  • I have read and approved the CLA

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 16, 2026

Greptile Summary

Adds a new "Spec" GitHub issue template (spec.yml) for technical specifications, complementing the existing Bug Report and Feature Request templates. The template provides a single required textarea pre-filled with structured sections (Summary, Motivation, Design with API/Interface, Architecture, and Implementation Notes) to standardize how contributors propose new modules, features, or system changes.

  • New file: .github/ISSUE_TEMPLATE/spec.yml with a structured markdown template
  • Follows the same YAML conventions as existing issue templates ([Spec]: title prefix, required: true validation)
  • No code changes; documentation/process improvement only

Confidence Score: 5/5

  • This PR is safe to merge — it only adds a new GitHub issue template with no code changes.
  • The change is a single new YAML file for a GitHub issue template. It follows existing conventions, has valid syntax, and poses zero risk to runtime behavior or application code.
  • No files require special attention.

Important Files Changed

Filename Overview
.github/ISSUE_TEMPLATE/spec.yml New issue template with structured spec sections; valid YAML, consistent with existing templates, no issues found.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User opens new GitHub Issue] --> B{Select Template}
    B --> C["Bug Report\n(bug_report.yml)"]
    B --> D["Feature Request\n(feature_request.yml)"]
    B --> E["Spec (NEW)\n(spec.yml)"]
    B --> F["Discord\n(config.yml link)"]
    E --> G["Pre-filled sections:\nSummary, Motivation,\nDesign, Architecture,\nImplementation Notes"]
    G --> H[Submit Spec Issue]
Loading

Last reviewed commit: 77bc5cc

@leshy leshy merged commit a499eac into dev Mar 16, 2026
12 checks passed
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