Fix #1342: revert to using Markdown format for issue templates#1416
Fix #1342: revert to using Markdown format for issue templates#1416mhucka wants to merge 8 commits into
Conversation
There was a problem hiding this comment.
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.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
There was a problem hiding this comment.
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.
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 createdoes not handle them – in fact, it doesn't even know they exist! Conversely, Markdown-based issue templates work fine usinggh, including when you open an external editor.There was a hope that maybe GitHub would add proper support for YAML-based issue templates in
gheventually, 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.