Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update issue templates for Cirq repo #6972

Open
mhucka opened this issue Jan 23, 2025 · 0 comments
Open

Update issue templates for Cirq repo #6972

mhucka opened this issue Jan 23, 2025 · 0 comments
Labels
kind/health For CI/testing/release process/refactoring/technical debt items kind/task A task that's part of a larger effort triage/accepted A consensus emerged that this bug report, feature request, or other action should be worked on

Comments

@mhucka
Copy link
Contributor

mhucka commented Jan 23, 2025

Description of the issue

The issue templates currently don't take advantage of GitHub features. Two in particular are:

  • Formatting: the issue templates use Markdown bold-face ** format directly instead of using heading formats for headings. Using ## for headings would make the templates a little easier to read, IMHO
  • GitHub supports issue forms and we should use them to ask the questions that are currently asked as text in the issue templates.
@mhucka mhucka added kind/health For CI/testing/release process/refactoring/technical debt items kind/task A task that's part of a larger effort labels Jan 23, 2025
@mhucka mhucka added the triage/accepted A consensus emerged that this bug report, feature request, or other action should be worked on label Feb 5, 2025
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/health For CI/testing/release process/refactoring/technical debt items kind/task A task that's part of a larger effort triage/accepted A consensus emerged that this bug report, feature request, or other action should be worked on
Projects
Status: No status
Development

No branches or pull requests

1 participant