Migrate bug report issue template from Markdown to YAML form#907
Migrate bug report issue template from Markdown to YAML form#907daatsuka wants to merge 1 commit intosolana-foundation:masterfrom
Conversation
|
@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 SummaryThis PR migrates the bug report issue template from GitHub's legacy Markdown-frontmatter format (
Confidence Score: 5/5
Important Files Changed
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
Reviews (1): Last reviewed commit: "resolve issue #902: [Bug]" | Re-trigger Greptile |
| title: "[Bug] " | ||
| labels: ["bug"] | ||
| assignees: | ||
| - ngundotra |
There was a problem hiding this comment.
@Woody4618 I think Noah is responsible for this no more. Whom should be added?
There was a problem hiding this comment.
Ah can add me or you and alex maybe
|
Please update to the current maintainers: |
| description: Create a report to help us improve | ||
| title: "[Bug] " | ||
| labels: ["bug"] | ||
| assignees: |
There was a problem hiding this comment.
| assignees: | |
| assignees: | |
| - Woody4618 | |
| - rogaldh | |
| - askov |
|
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. |
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 deletesbug_report.mdand replaces it withbug_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: textareaelement with its ownid,label,description, andplaceholder. The first four of those fields carryrequired: 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
requiredvalidation server-side — no amount of creative editing can bypass it. I verified the change locally by runningpython -c "import yaml, sys; yaml.safe_load(open(sys.argv[1]))" .github/ISSUE_TEMPLATE/bug_report.ymlto 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
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
build:infoscript to update build informationAdditional 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.