Issue templates for Cirq repo would benefit from updates #6972
Assignees
Labels
area/github
kind/task
A task that's part of a larger effort
priority/after-1.5
Leave for after the Cirq 1.5 release
triage/accepted
A consensus emerged that this bug report, feature request, or other action should be worked on
Milestone
Comments
mhucka
added
kind/health
mhucka
added
the
triage/accepted
mhucka
added a commit
to mhucka/Cirq
that referenced
this issue
Feb 24, 2025
The edits here are an attempt to do the following: - Use Markdown section headings instead of `**` bold facing text - Remove some redundant sections - Make the descriptions and headings all follow the same style - Try to make the text slightly more clear in a few places This partly half of quantumlib#6972. The other half (using issue forms) can be left for some later date.
github-merge-queue bot
pushed a commit
that referenced
this issue
Feb 28, 2025
* Edit and (try to) improve issue templates The edits here are an attempt to do the following: - Use Markdown section headings instead of `**` bold facing text - Remove some redundant sections - Make the descriptions and headings all follow the same style - Try to make the text slightly more clear in a few places This partly half of #6972. The other half (using issue forms) can be left for some later date. * Use explicit line breaks * Add language declarations to Markdown code blocks * Fix several code block language declarations Fixed errors spotted by @pavoljuhas in review comments on PR #7087.
mhucka
added
area/github
priority/after-1.5
mhucka
changed the title
|
I recently did the first item (improving the Markdown). Still need to do the second. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description of the issue
The issue templates currently don't take advantage of GitHub features. Two in particular are:
**format directly instead of using heading formats for headings. Using##for headings would make the templates a little easier to read, IMHOThe text was updated successfully, but these errors were encountered: