Skip to content

Commit ec0850d

Browse files
tobiasdiezMatthias Köppe
authored and
dimpase
committed
Add issue and PR templates
Improved version based on https://github.com/sagemath/sage-gh-templates-sandbox Fixes sagemath/trac-to-github#86. Co-authored-by: Matthias Köppe <[email protected]>
1 parent 66b319b commit ec0850d

File tree

5 files changed

+187
-4
lines changed

5 files changed

+187
-4
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Bug Report
2+
description: Report a bug
3+
title: "<title>"
4+
labels: "t: bug"
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 sectionin 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
21+
attributes:
22+
label: Environment
23+
description: |
24+
examples:
25+
- **OS**: Ubuntu 20.04
26+
- Sage Version: 9.2
27+
value: |
28+
- **OS**:
29+
- **Sage Version**:
30+
render: markdown
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: Steps To Reproduce
36+
description: Steps to reproduce the behavior.
37+
placeholder: |
38+
1. In this environment...
39+
2. With this config...
40+
3. Run '...'
41+
4. See error...
42+
validations:
43+
required: false
44+
- type: textarea
45+
attributes:
46+
label: Expected Behavior
47+
description: A clear and concise description of what you expected to happen.
48+
validations:
49+
required: true
50+
- type: textarea
51+
attributes:
52+
label: Actual Behavior
53+
description: A clear description of what actually happens.
54+
validations:
55+
required: true
56+
- type: textarea
57+
attributes:
58+
label: Additional Information
59+
description: |
60+
Links? References? Anything that will give us more context about the issue you are encountering!
61+
validations:
62+
required: false

‎.github/ISSUE_TEMPLATE/failure_building_from_source.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Failure building from source
2+
description: Use this template when reporting a build failure
3+
title: "<title>"
4+
labels: ['c: build', 't: bug']
5+
assignees: []
6+
body:
7+
- type: checkboxes
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
21+
- type: textarea
22+
attributes:
23+
label: Environment
24+
description: |
25+
examples:
26+
- **OS**: Ubuntu 20.04
27+
- Sage Version: 9.2
28+
value: |
29+
- **OS**:
30+
- **Sage Version**:
31+
render: markdown
32+
validations:
33+
required: true
34+
- type: textarea
35+
attributes:
36+
label: Steps To Reproduce
37+
description: Steps to reproduce the behavior.
38+
placeholder: |
39+
1. In this environment...
40+
2. With this config...
41+
3. Run '...'
42+
4. See error...
43+
validations:
44+
required: false
45+
- type: textarea
46+
attributes:
47+
label: Config log
48+
description: |
49+
Please attach `config.log`.
50+
Tip: You can attach log files by clicking this area to highlight it and then dragging files in.
51+
validations:
52+
required: true
53+
- type: textarea
54+
attributes:
55+
label: Package logs
56+
description: |
57+
Please attach ̀`logs/pkgs/SPKG.log` for failing packages.
58+
Tip: You can attach log files by clicking this area to highlight it and then dragging files in.
59+
validations:
60+
required: false
61+
- type: textarea
62+
attributes:
63+
label: Additional Information
64+
description: |
65+
Links? References? Anything that will give us more context about the issue you are encountering!
66+
validations:
67+
required: false

‎.github/ISSUE_TEMPLATE/feature_report.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Feature Request
2+
description: Suggest an idea
3+
title: "<title>"
4+
labels: "t: enhancement"
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: textarea
14+
attributes:
15+
label: Problem Description
16+
description: Please add a clear and concise description of the problem you are seeking to solve with this feature request.
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Proposed Solution
22+
description: Describe the solution you'd like in a clear and concise manner.
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Alternatives Considered
28+
description: A clear and concise description of any alternative solutions or features you've considered.
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: Additional Information
34+
description: Add any other context about the problem here.
35+
validations:
36+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,23 @@
1-
Thanks for contributing to Sage! Detailed instructions to be added shortly.
1+
### 📚 Description
2+
3+
<!-- Describe your changes in detail -->
4+
<!-- Why is this change required? What problem does it solve? -->
5+
<!-- If it resolves an open issue, please link to the issue here. For example "Closes #1337" -->
6+
7+
### 📝 Checklist
8+
9+
<!-- Put an `x` in all the boxes that apply. -->
10+
<!-- If your change requires a documentation PR, please link it appropriately -->
11+
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
12+
13+
- [ ] I have linked an issue or discussion.
14+
- [ ] I have created tests covering the changes.
15+
- [ ] I have updated the documentation accordingly.
16+
17+
### ⌛ Dependencies
18+
<!-- List all open pull requests that this PR logically depends on -->
19+
<!--
20+
- #xyz: short description why this is a dependency
21+
- #abc: ...
22+
-->
223

3-
Please make sure to also have a look at our
4-
[Code Style Conventions](https://doc.sagemath.org/html/en/developer/coding_basics.html).

0 commit comments

Comments
 (0)