Skip to content

Commit e60e686

Browse files
authored
Improve GitHub issue templates (#7087)
* 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.
1 parent fe946a1 commit e60e686

File tree

5 files changed

+44
-56
lines changed

5 files changed

+44
-56
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,33 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: Report a bug or problem in Cirq or the project
44
title: ''
55
labels: 'kind/bug-report'
66
assignees: ''
7-
87
---
8+
## Describe the issue
99

10-
**Description of the issue**
1110

12-
**How to reproduce the issue**
11+
## Explain how to reproduce the bug or problem
1312

1413
```
1514
16-
put code in code blocks *like this*
15+
Put code in Markdown code blocks *like this*.
1716
1817
```
1918

2019
<details>
2120

22-
put long logs in details blocks *like this*
21+
Put long logs in HTML details blocks *like this*.
2322

2423
</details>
2524

26-
**Cirq version**
27-
You can get the cirq version by printing `cirq.__version__`. From the command line:
2825

29-
```
26+
## Tell us the version of Cirq where this happens
27+
28+
You can get the Cirq version you are running by using Python
29+
to print the value of `cirq.__version__`. From the command line:
30+
31+
```shell
3032
python -c 'import cirq; print(cirq.__version__)'
3133
```
32-
+7-11
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
11
---
22
name: Design discussion
3-
about: Start a conversation on a design problem / opportunity
3+
about: Start a conversation about a design problem or opportunity
44
title: ''
55
labels: 'kind/design-issue'
66
assignees: ''
7-
87
---
9-
10-
<!--
11-
Note: this is an open ended discussion that may or may not become a feature.
12-
If you are blocked by this, please raise a feature request instead.
8+
<!--
9+
Note: this type of issue is for open-ended discussions that may
10+
or may not be implemented. If you are blocked by the problem,
11+
please open a feature request instead.
1312
-->
14-
15-
**Is your design idea/issue related to a use case or problem? Please describe.**
16-
17-
18-
**Describe your design idea/issue**
13+
## Is your design idea/issue related to a use case or problem? Please explain
1914

2015

16+
## Describe your design idea/issue
+13-19
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,24 @@
11
---
22
name: Feature request
3-
about: Submit a feature request
3+
about: Request a new feature or change in Cirq or the project
44
title: ''
55
labels: 'kind/feature-request'
66
assignees: ''
7-
87
---
8+
## Is your feature request related to a use case or problem? Please explain
99

10-
**Is your feature request related to a use case or problem? Please describe.**
11-
12-
13-
**Describe the solution you'd like**
14-
15-
16-
**[optional] Describe alternatives/workarounds you've considered**
17-
18-
19-
**[optional] Additional context (e.g. screenshots)**
10+
## Describe the solution you would prefer
2011

12+
## How urgent is this for you? Is it blocking important work?
2113

22-
**What is the urgency from your perspective for this issue? Is it blocking important work?**
23-
<!-- Please choose one and remove the others -->
14+
<!-- Please choose one of the following options and remove the others -->
15+
**P0** – this should land no later than a week<br>
16+
**P1** – I need this no later than the next release<br>
17+
**P2** – we should do it in the next couple of quarters<br>
18+
**P3** – I'm not really blocked by it; it's an idea I'm proposing based on principle
2419

25-
P0 - this should land no later than a week
26-
P1 - I need this no later than the next release (end of quarter)
27-
P2 - we should do it in the next couple of quarters
28-
P3 - I'm not really blocked by it, it is an idea I'd like to discuss / suggestion based on principle
20+
<!-- Optional; feel free to remove the next section if it's not relevant. -->
21+
## Describe alternatives/workarounds you've considered
2922

30-
<!-- [optional] additional comment / context -->
23+
<!-- Optional; feel free to remove the next section if it's not relevant. -->
24+
## Provide additional information or context (e.g., screenshots)
+7-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
---
2-
name: Project health
3-
about: Issues related to CI, automation infra, clean code, deprecation
2+
name: Project health issue
3+
about: Report an issue related to CI, automation, clean code, procedures, etc.
44
title: ''
55
labels: 'kind/health'
66
assignees: ''
7-
87
---
8+
## Describe the issue
99

10-
**Description of the issue**
1110

11+
## Tell us the version of Cirq where this happens
1212

13-
**Cirq version**
14-
You can get the cirq version by printing `cirq.__version__`. From the command line:
13+
You can get the Cirq version you are running by using Python
14+
to print the value of `cirq.__version__`. From the command line:
1515

16-
```
16+
```shell
1717
python -c 'import cirq; print(cirq.__version__)'
1818
```
19-

.github/ISSUE_TEMPLATE/task.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
---
22
name: Project task
3-
about: Task to track larger efforts
3+
about: Describe a task (typically as part of a larger effort)
44
title: ''
55
labels: 'kind/task'
66
assignees: ''
7-
87
---
9-
10-
**Summarize the task**
8+
## Summarize the task
119

1210

13-
**Acceptance criteria - when is the task considered done?**
11+
## Acceptance criteria when will the task be considered done?
1412

1513

16-
<!-- optional, feel free to remove this section -->
17-
**Related**
14+
<!-- Optional; feel free to remove the next section if it's not relevant. -->
15+
## Related issues
1816

19-
Related issues: #abc, #xyz, ...
17+
Refer to related issues #abc, #xyz, ...

0 commit comments

Comments
 (0)