Skip to content

Commit f6e3c53

Browse files
author
Release Manager
committed
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
2 parents 853d070 + f2a3896 commit f6e3c53

File tree

4 files changed

+55
-51
lines changed

4 files changed

+55
-51
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,11 @@ description: Report a bug
33
title: "<title>"
44
labels: "t: bug"
55
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
217
attributes:
22-
label: Environment
23-
description: |
24-
examples:
25-
- **OS**: Ubuntu 20.04
26-
- Sage Version: 9.2
278
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).
3311
- type: textarea
3412
attributes:
3513
label: Steps To Reproduce
@@ -60,3 +38,24 @@ body:
6038
Links? References? Anything that will give us more context about the issue you are encountering!
6139
validations:
6240
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
61+
required: true

.github/ISSUE_TEMPLATE/failure_building_from_source.yml

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,11 @@ title: "<title>"
44
labels: ['c: build', 't: bug']
55
assignees: []
66
body:
7-
- type: checkboxes
7+
- type: markdown
88
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).
2112
- type: textarea
2213
attributes:
2314
label: Environment
@@ -65,3 +56,11 @@ body:
6556
Links? References? Anything that will give us more context about the issue you are encountering!
6657
validations:
6758
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
66+
required: true

.github/ISSUE_TEMPLATE/feature_report.yml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,10 @@ description: Suggest an idea
33
title: "<title>"
44
labels: "t: enhancement"
55
body:
6-
- type: checkboxes
6+
- type: markdown
77
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
8+
value: |
9+
* Please search to see if an issue already exists for the bug you encountered.
1310
- type: textarea
1411
attributes:
1512
label: Problem Description
@@ -34,3 +31,9 @@ body:
3431
description: Add any other context about the problem here.
3532
validations:
3633
required: false
34+
- type: checkboxes
35+
attributes:
36+
label: Is there an existing issue for this?
37+
options:
38+
- label: I have searched the existing issues for a bug report that matches the one I want to file, without success.
39+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
1-
<!-- Please provide a concise, informative and self-explanatory title. -->
2-
<!-- Don't put issue numbers in the title. Put it in the Description below. -->
3-
<!-- For example, instead of "Fixes #12345", use "Add a new method to multiply two integers" -->
4-
5-
### :books: Description
1+
<!-- ^^^^^
2+
Please provide a concise, informative and self-explanatory title.
3+
Don't put issue numbers in there, do this in the PR body below.
4+
For example, instead of "Fixes #1234" use "Introduce new method to calculate 1+1"
5+
-->
6+
<!-- Describe your changes here in detail -->
67

7-
<!-- Describe your changes here in detail. -->
88
<!-- Why is this change required? What problem does it solve? -->
99
<!-- If this PR resolves an open issue, please link to it here. For example "Fixes #12345". -->
1010
<!-- If your change requires a documentation PR, please link it appropriately. -->
1111

1212
### :memo: Checklist
1313

14-
<!-- Put an `x` in all the boxes that apply. It should be `[x]` not `[x ]`. -->
14+
<!-- Put an `x` in all the boxes that apply. -->
15+
<!-- If your change requires a documentation PR, please link it appropriately -->
16+
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
17+
<!-- Feel free to remove irrelevant items. -->
1518

1619
- [ ] The title is concise, informative, and self-explanatory.
1720
- [ ] The description explains in detail what this PR is about.

0 commit comments

Comments
 (0)