Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: Added more templates #738

Merged
merged 6 commits into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,27 @@
name: Bug report
description: Report to help us reproduce the bug
title: "Bug: "
labels: ["bug", "needs triage"]

body:
- type: markdown
attributes:
value: >
## Thanks for taking the time to fill out this report
- type: markdown
- type: checkboxes
id: checks
attributes:
value: >
### Before submitting a bug, please make sure it has not been reported in the
[list of issues](https://github.com/pydata/sparse/issues).
label: sparse version checks
options:
- label: >
I checked that this issue has not been reported before
[list of issues](https://github.com/pydata/sparse/issues).
required: true
- label: >
I have confirmed this bug exists on the latest version of sparse.
required: true
- label: >
I have confirmed this bug exists on the main branch of sparse.
- type: textarea
attributes:
label: Describe the bug
Expand Down Expand Up @@ -45,12 +55,11 @@ body:
- type: textarea
attributes:
label: Please describe your system.
render: shell
placeholder: |
value: |
1. OS and version: [e.g. Windows 10]
2. `sparse` version (`sparse.__version__`)
hameerabbasi marked this conversation as resolved.
Show resolved Hide resolved
3. NumPy version (`np.__version__`)
4. Numba version (`numba.__version__`)
2. sparse version (sparse.__version__)
3. NumPy version (np.__version__)
4. Numba version (numba.__version__)
validations:
required: true
- type: textarea
Expand Down
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
blank_issues_enabled: true
name: Blank issue
url: https://github.com/pydata/sparse/issues/new
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/doc_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Documentation improvement
description: Report to improve the docs. You could also directly open a PR with your suggestions.
title: "Doc: "
labels: ["docs", "needs triage"]

body:
- type: markdown
attributes:
value: >
## Thanks for taking the time to fill out this form
- type: dropdown
id: TYPE
attributes:
label: What type of report is this?
options:
- 'Correction'
- 'Improvement'
validations:
required: true
- type: textarea
attributes:
label: Please describe the issue.
description: >
Tell us if something is unclear or incorrect, and where.
validations:
required: true
- type: textarea
attributes:
label: If you have a suggestion on how it should be, add it below.
description: >
How can we improve it
- type: markdown
attributes:
value: >
### If you are interested in opening a pull request to fix this, please let us know.
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Feature request
description: Form to request a new feature
title: "Enh: "
labels: ["enhancement", "needs triage"]

body:
- type: markdown
attributes:
value: >
## Thanks for helping us improve sparse!
- type: markdown
attributes:
value: >
### Before submitting a request, please check if it has already been discused in the
[list of issues](https://github.com/pydata/sparse/issues).
- type: textarea
attributes:
label: Please describe the purpose of the new feature or describe the problem to solve.
description: >
A clear description of the objective.
validations:
required: true
- type: textarea
attributes:
label: Suggest a solution if possible.
description: >
Please suggest a solution if you can.
validations:
required: false
- type: textarea
attributes:
label: If you have tried alternatives, please describe them below.
description: >
What you have tried if applicable.
- type: textarea
attributes:
label: Additional information that may help us understand your needs.
description: >
Context, screenshots, or any useful information.
- type: markdown
attributes:
value: >
### If you are interested in opening a pull request to fix this, please let us know.
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/question-support.md

This file was deleted.

21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/question-support.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Question/Support
description: A question about how to use this library.
title: "Usage: "
labels: "usage"

body:
- type: markdown
attributes:
value: >
## Thank you for your interest in sparse
- type: textarea
attributes:
label: Please provide a description of what you'd like to do.
validations:
required: true
- type: textarea
attributes:
label: Example Code
description: >
Syntactically valid Python code that shows what you want to do,
possibly with placeholder functions or methods.
4 changes: 2 additions & 2 deletions .github/workflows/codspeed.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ name: codspeed-benchmarks
on:
push:
branches:
#- "main" # or "master"
- "benchmarks" # or "master"
- "main" # or "master"

pull_request:
# `workflow_dispatch` allows CodSpeed to trigger backtest
# performance analysis in order to generate initial data.
Expand Down
Loading