You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
gh-35295: put the actual description first in issue templates
...so that relevant information appears when hovering over items of the
issue list, and so that one can read the actual issue on the issue page
without scrolling over a full page of boilerplate.
Also remove the title from the Description section of the PR template
(same rationale).
Any opinions on that?
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes#1234" use "Introduce new method to
calculate 1+1"
-->
### 📚 Description
<!-- Describe your changes here in detail -->
<!-- Why is this change required? What problem does it solve? -->
<!-- If it resolves an open issue, please link to the issue here. For
example "Closes#1337" -->
### 📝 Checklist
<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
- [x] I have made sure that the title is self-explanatory and the
description concisely explains the PR.
- [ ] I have linked an issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.
### ⌛ Dependencies
<!-- List all open pull requests that this PR logically depends on -->
<!--
- #xyz: short description why this is a dependency
- #abc: ...
-->
URL: #35295
Reported by: Marc Mezzarobba
Reviewer(s): Dima Pasechnik, Marc Mezzarobba, Tobias Diez
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug_report.yml
+24-25Lines changed: 24 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -3,33 +3,11 @@ description: Report a bug
3
3
title: "<title>"
4
4
labels: "t: bug"
5
5
body:
6
-
- type: checkboxes
7
-
attributes:
8
-
label: Is there an existing issue for this?
9
-
description: Please search to see if an issue already exists for the bug you encountered.
10
-
options:
11
-
- label: I have searched the existing issues for a bug report that matches the one I want to file, without success.
12
-
required: true
13
-
- type: checkboxes
14
-
attributes:
15
-
label: Did you read the documentation and troubleshoot guide?
16
-
description: Please read [README.md](https://github.com/sagemath/sage/blob/develop/README.md) and [the Troubleshooting section in the Installation Guide](https://doc.sagemath.org/html/en/installation/troubles.html).
17
-
options:
18
-
- label: I have read the documentation and troubleshoot guide
19
-
required: true
20
-
- type: textarea
6
+
- type: markdown
21
7
attributes:
22
-
label: Environment
23
-
description: |
24
-
examples:
25
-
- **OS**: Ubuntu 20.04
26
-
- Sage Version: 9.2
27
8
value: |
28
-
- **OS**:
29
-
- **Sage Version**:
30
-
render: markdown
31
-
validations:
32
-
required: true
9
+
* Please search to see if an issue already exists for the bug you encountered.
10
+
* Please read [README.md](https://github.com/sagemath/sage/blob/develop/README.md) and [the Troubleshooting section in the Installation Guide](https://doc.sagemath.org/html/en/installation/troubles.html).
33
11
- type: textarea
34
12
attributes:
35
13
label: Steps To Reproduce
@@ -60,3 +38,24 @@ body:
60
38
Links? References? Anything that will give us more context about the issue you are encountering!
61
39
validations:
62
40
required: false
41
+
- type: textarea
42
+
attributes:
43
+
label: Environment
44
+
description: |
45
+
examples:
46
+
- **OS**: Ubuntu 20.04
47
+
- Sage Version: 9.2
48
+
value: |
49
+
- **OS**:
50
+
- **Sage Version**:
51
+
render: markdown
52
+
validations:
53
+
required: true
54
+
- type: checkboxes
55
+
attributes:
56
+
label: Checklist
57
+
options:
58
+
- label: I have searched the existing issues for a bug report that matches the one I want to file, without success.
59
+
required: true
60
+
- label: I have read the documentation and troubleshoot guide
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/failure_building_from_source.yml
+12-13Lines changed: 12 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -4,20 +4,11 @@ title: "<title>"
4
4
labels: ['c: build', 't: bug']
5
5
assignees: []
6
6
body:
7
-
- type: checkboxes
7
+
- type: markdown
8
8
attributes:
9
-
label: Is there an existing issue for this?
10
-
description: Please search to see if an issue already exists for the bug you encountered.
11
-
options:
12
-
- label: I have searched the existing issues for a bug report that matches the one I want to file, without success.
13
-
required: true
14
-
- type: checkboxes
15
-
attributes:
16
-
label: Did you read the documentation and troubleshoot guide?
17
-
description: Please read [README.md](https://github.com/sagemath/sage/blob/develop/README.md) and [the Troubleshooting sectionin the Installation Guide](https://doc.sagemath.org/html/en/installation/troubles.html).
18
-
options:
19
-
- label: I have read the documentation and troubleshoot guide
20
-
required: true
9
+
value: |
10
+
* Please search to see if an issue already exists for the bug you encountered.
11
+
* Please read [README.md](https://github.com/sagemath/sage/blob/develop/README.md) and [the Troubleshooting section in the Installation Guide](https://doc.sagemath.org/html/en/installation/troubles.html).
21
12
- type: textarea
22
13
attributes:
23
14
label: Environment
@@ -65,3 +56,11 @@ body:
65
56
Links? References? Anything that will give us more context about the issue you are encountering!
66
57
validations:
67
58
required: false
59
+
- type: checkboxes
60
+
attributes:
61
+
label: Checklist
62
+
options:
63
+
- label: I have searched the existing issues for a bug report that matches the one I want to file, without success.
64
+
required: true
65
+
- label: I have read the documentation and troubleshoot guide
0 commit comments