Skip to content

Migrate bug report issue template from Markdown to YAML form#907

Open
daatsuka wants to merge 1 commit intosolana-foundation:masterfrom
daatsuka:the-issue-is-a-blank-bug-report-template-with-no-a
Open

Migrate bug report issue template from Markdown to YAML form#907
daatsuka wants to merge 1 commit intosolana-foundation:masterfrom
daatsuka:the-issue-is-a-blank-bug-report-template-with-no-a

Conversation

@daatsuka
Copy link
Copy Markdown

Description

The old bug report template (.github/ISSUE_TEMPLATE/bug_report.md) used GitHub's legacy Markdown-frontmatter format. When a user opened a new issue the template rendered as placeholder prose that they could freely delete, and every field was optional by default — which is exactly how issue #902 ended up as a blank "[Bug]" title with an empty body. This PR deletes bug_report.md and replaces it with bug_report.yml, GitHub's YAML-based Issue Forms schema.

Each section that existed in the old template — "Describe the bug", "To Reproduce", "Example Links", "Expected behavior", "Screenshots", and "Additional context" — is now declared as a type: textarea element with its own id, label, description, and placeholder. The first four of those fields carry required: true, so GitHub will block submission until the reporter fills them in. "Screenshots" and "Additional context" remain optional because they genuinely are supplementary. The top-level metadata (name, title, labels, assignees) is preserved identically so the issue creation experience stays the same for triagers; the only difference reporters will notice is that blank submissions are no longer possible.

I chose YAML Issue Forms over simply adding "REQUIRED" comments to the Markdown template because GitHub enforces required validation server-side — no amount of creative editing can bypass it. I verified the change locally by running python -c "import yaml, sys; yaml.safe_load(open(sys.argv[1]))" .github/ISSUE_TEMPLATE/bug_report.yml to confirm the file parses without errors, and by pushing the branch to a personal fork and opening "New Issue" to confirm the form renders correctly with all six fields and the expected required/optional markers.

Type of change

  • Bug fix
  • New feature
  • Protocol integration
  • Documentation update
  • Other (please describe):

Screenshots

N/A — this is an issue-template change, not a UI change. The rendered form can be previewed by navigating to the "New Issue" page on the fork.

Testing

Validated the YAML syntax with a local YAML parser to ensure no parse errors. Pushed the branch to a fork and confirmed the Issue Form renders correctly on GitHub's "New Issue" page: all six textarea fields appear with their labels, descriptions, and placeholders, and GitHub blocks submission when any of the four required fields is left empty.

Related Issues

Closes #902

Checklist

  • My code follows the project's style guidelines
  • I have added tests that prove my fix/feature works
  • All tests pass locally and in CI
  • I have updated documentation as needed
  • I have run build:info script to update build information
  • CI/CD checks pass
  • I have included screenshots for protocol screens (if applicable)
  • For security-related features, I have included links to related information

Additional Notes

No runtime code is touched — this change is scoped entirely to .github/ISSUE_TEMPLATE/. The "added tests" and "build:info" checklist items are intentionally left unchecked because they do not apply to an issue-template migration.

@vercel
Copy link
Copy Markdown

vercel Bot commented Mar 25, 2026

@daatsuka is attempting to deploy a commit to the Solana Foundation Team on Vercel.

A member of the Team first needs to authorize it.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Mar 25, 2026

Greptile Summary

This PR migrates the bug report issue template from GitHub's legacy Markdown-frontmatter format (bug_report.md) to the structured YAML Issue Forms format (bug_report.yml), directly addressing issue #902 where a blank bug report was submitted because the old template imposed no validation.

  • The new form declares six textarea fields matching the original template sections: Describe the bug, To Reproduce, Example Links, Expected behavior, Screenshots, and Additional context.
  • The first four fields carry required: true, enforcing server-side validation that prevents blank submissions.
  • Top-level metadata (name, title, labels, assignees) is faithfully preserved from the old template; the only functional addition is the trailing space in title: "[Bug] " to pre-position the reporter's cursor.
  • required: false on the two optional fields is redundant (fields are optional by default in Issue Forms) but is harmless and makes intent explicit.
  • No runtime code is affected; the change is scoped entirely to .github/ISSUE_TEMPLATE/.

Confidence Score: 5/5

  • This PR is safe to merge — it is a purely additive template migration with no runtime code changes and correct YAML Issue Forms syntax.
  • The change is scoped entirely to .github/ISSUE_TEMPLATE/, touches no application code, and the YAML structure is valid and correctly follows the GitHub Issue Forms schema. All required fields are properly declared, metadata is faithfully preserved, and the only minor observation (redundant required: false) is harmless. No blockers or regressions are possible.
  • No files require special attention.

Important Files Changed

Filename Overview
.github/ISSUE_TEMPLATE/bug_report.md Legacy Markdown issue template deleted; replaced entirely by the new YAML form. No runtime impact.
.github/ISSUE_TEMPLATE/bug_report.yml New GitHub Issue Forms YAML template with 4 required fields (description, reproduce, example-links, expected) and 2 optional fields (screenshots, additional context). Structure is valid; required: false declarations are redundant but harmless.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A([Reporter opens New Issue]) --> B[Selects Bug Report form]
    B --> C[Fills in **Describe the bug** ✱]
    C --> D[Fills in **To Reproduce** ✱]
    D --> E[Fills in **Example Links** ✱]
    E --> F[Fills in **Expected behavior** ✱]
    F --> G[Screenshots - optional]
    G --> H[Additional context - optional]
    H --> I{All required\nfields filled?}
    I -- No --> J[GitHub blocks submission\nHighlights missing fields]
    J --> C
    I -- Yes --> K([Issue submitted with\ncomplete bug report])

    style J fill:#f66,color:#fff
    style K fill:#4caf50,color:#fff
Loading

Reviews (1): Last reviewed commit: "resolve issue #902: [Bug]" | Re-trigger Greptile

title: "[Bug] "
labels: ["bug"]
assignees:
- ngundotra
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@Woody4618 I think Noah is responsible for this no more. Whom should be added?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Ah can add me or you and alex maybe

@solana-foundation solana-foundation deleted a comment from PatSayJak Mar 27, 2026
@rogaldh
Copy link
Copy Markdown
Contributor

rogaldh commented Mar 27, 2026

@daatsuka

Please update to the current maintainers:

assignees:                                                                                                                                                                                                       
  - Woody4618                                                                                                                                                                                                  
  - rogaldh                                                                                                                                                                                                      
  - askov

Copy link
Copy Markdown
Contributor

@rogaldh rogaldh left a comment

Choose a reason for hiding this comment

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

LGTM

description: Create a report to help us improve
title: "[Bug] "
labels: ["bug"]
assignees:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
assignees:
assignees:
- Woody4618
- rogaldh
- askov

@Woody4618
Copy link
Copy Markdown
Collaborator

Thanks for the PR, this looks like a good addition. @daatsuka do you still want to do the changes otherwise we could also take it from here.

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.

[Bug]

3 participants