Skip to content

Fix #1342: revert to using Markdown format for issue templates#1416

Open
mhucka wants to merge 8 commits into
quantumlib:mainfrom
mhucka:convert-issue-templates
Open

Fix #1342: revert to using Markdown format for issue templates#1416
mhucka wants to merge 8 commits into
quantumlib:mainfrom
mhucka:convert-issue-templates

Conversation

@mhucka

@mhucka mhucka commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

GitHub issue forms seemed like a good idea, and the web interface is nice. After using them for some time, though, they turn out to introduce too much friction:

  • On the command-line, gh issue create does not handle them – in fact, it doesn't even know they exist! Conversely, Markdown-based issue templates work fine using gh, including when you open an external editor.

  • There was a hope that maybe GitHub would add proper support for YAML-based issue templates in gh eventually, but that still has not happened.

  • The YAML version of templates is harder and more error-prone to edit and maintain.

This converts the forms back to GitHub's Markdown format for issue templates.

@gemini-code-assist gemini-code-assist Bot left a comment

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.

Code Review

This pull request transitions the repository's GitHub issue templates from YAML configuration files to Markdown-based templates, introducing new templates for bug reports, feature requests, questions, and tasks. Feedback on the changes points out that in the bug report template, the front matter key for the template description should be about instead of description to ensure it displays correctly in the GitHub issue chooser.

Comment thread .github/ISSUE_TEMPLATE/1-bug-report.md Outdated
mhucka and others added 2 commits July 14, 2026 20:26
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@mhucka mhucka changed the title Revert to using issue templates in Markdown format Fix #1342: revert to using Markdown format for issue templates Jul 15, 2026
@mhucka mhucka requested review from arettig and fdmalone July 15, 2026 03:36
@mhucka mhucka marked this pull request as draft July 15, 2026 03:43
@mhucka mhucka marked this pull request as ready for review July 15, 2026 04:40

@gemini-code-assist gemini-code-assist Bot left a comment

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.

Code Review

This pull request updates the GitHub issue templates by replacing the previous YAML-based bug report and feature request forms with Markdown-based templates. It also introduces a new Markdown template for project tasks and updates the issue configuration file (config.yml) to include contact links for GitHub Discussions and OpenFermion documentation. There are no review comments, and I have no feedback to provide.

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.

1 participant