Skip to content

Commit d42b5db

Browse files
authored
ci: Added more templates (#738)
1 parent e00f524 commit d42b5db

File tree

8 files changed

+122
-45
lines changed

8 files changed

+122
-45
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,27 @@
11
name: Bug report
22
description: Report to help us reproduce the bug
33
title: "Bug: "
4+
labels: ["bug", "needs triage"]
45

56
body:
67
- type: markdown
78
attributes:
89
value: >
910
## Thanks for taking the time to fill out this report
10-
- type: markdown
11+
- type: checkboxes
12+
id: checks
1113
attributes:
12-
value: >
13-
### Before submitting a bug, please make sure it has not been reported in the
14-
[list of issues](https://github.com/pydata/sparse/issues).
14+
label: sparse version checks
15+
options:
16+
- label: >
17+
I checked that this issue has not been reported before
18+
[list of issues](https://github.com/pydata/sparse/issues).
19+
required: true
20+
- label: >
21+
I have confirmed this bug exists on the latest version of sparse.
22+
required: true
23+
- label: >
24+
I have confirmed this bug exists on the main branch of sparse.
1525
- type: textarea
1626
attributes:
1727
label: Describe the bug
@@ -45,12 +55,11 @@ body:
4555
- type: textarea
4656
attributes:
4757
label: Please describe your system.
48-
render: shell
49-
placeholder: |
58+
value: |
5059
1. OS and version: [e.g. Windows 10]
51-
2. `sparse` version (`sparse.__version__`)
52-
3. NumPy version (`np.__version__`)
53-
4. Numba version (`numba.__version__`)
60+
2. sparse version (sparse.__version__)
61+
3. NumPy version (np.__version__)
62+
4. Numba version (numba.__version__)
5463
validations:
5564
required: true
5665
- type: textarea

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
blank_issues_enabled: true
2+
name: Blank issue
3+
url: https://github.com/pydata/sparse/issues/new

.github/ISSUE_TEMPLATE/doc_issue.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Documentation improvement
2+
description: Report to improve the docs. You could also directly open a PR with your suggestions.
3+
title: "Doc: "
4+
labels: ["docs", "needs triage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
## Thanks for taking the time to fill out this form
11+
- type: dropdown
12+
id: TYPE
13+
attributes:
14+
label: What type of report is this?
15+
options:
16+
- 'Correction'
17+
- 'Improvement'
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: Please describe the issue.
23+
description: >
24+
Tell us if something is unclear or incorrect, and where.
25+
validations:
26+
required: true
27+
- type: textarea
28+
attributes:
29+
label: If you have a suggestion on how it should be, add it below.
30+
description: >
31+
How can we improve it
32+
- type: markdown
33+
attributes:
34+
value: >
35+
### If you are interested in opening a pull request to fix this, please let us know.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Feature request
2+
description: Form to request a new feature
3+
title: "Enh: "
4+
labels: ["enhancement", "needs triage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
## Thanks for helping us improve sparse!
11+
- type: markdown
12+
attributes:
13+
value: >
14+
### Before submitting a request, please check if it has already been discused in the
15+
[list of issues](https://github.com/pydata/sparse/issues).
16+
- type: textarea
17+
attributes:
18+
label: Please describe the purpose of the new feature or describe the problem to solve.
19+
description: >
20+
A clear description of the objective.
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: Suggest a solution if possible.
26+
description: >
27+
Please suggest a solution if you can.
28+
validations:
29+
required: false
30+
- type: textarea
31+
attributes:
32+
label: If you have tried alternatives, please describe them below.
33+
description: >
34+
What you have tried if applicable.
35+
- type: textarea
36+
attributes:
37+
label: Additional information that may help us understand your needs.
38+
description: >
39+
Context, screenshots, or any useful information.
40+
- type: markdown
41+
attributes:
42+
value: >
43+
### If you are interested in opening a pull request to fix this, please let us know.

.github/ISSUE_TEMPLATE/question-support.md

Lines changed: 0 additions & 14 deletions
This file was deleted.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Question/Support
2+
description: A question about how to use this library.
3+
title: "Usage: "
4+
labels: "usage"
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
## Thank you for your interest in sparse
11+
- type: textarea
12+
attributes:
13+
label: Please provide a description of what you'd like to do.
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: Example Code
19+
description: >
20+
Syntactically valid Python code that shows what you want to do,
21+
possibly with placeholder functions or methods.

.github/workflows/codspeed.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ name: codspeed-benchmarks
33
on:
44
push:
55
branches:
6-
#- "main" # or "master"
7-
- "benchmarks" # or "master"
6+
- "main" # or "master"
7+
88
pull_request:
99
# `workflow_dispatch` allows CodSpeed to trigger backtest
1010
# performance analysis in order to generate initial data.

0 commit comments

Comments
 (0)