Skip to content

Commit 58fd2c2

Browse files
brandonwillardbrandonwillard
committed
Update the GitHub issues template
1 parent 44bd852 commit 58fd2c2

File tree

8 files changed

+302
-36
lines changed

8 files changed

+302
-36
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
# Inspired by https://github.com/doomemacs/doomemacs/blob/master/.github/ISSUE_TEMPLATE/bug_report.yml
3+
name: 📝 Bug Report
4+
description: Report something that isn't working as intended
5+
labels: ["bug"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
First, carefully read [CONTRIBUTING.md](https://github.com/aesara-devs/aesara/blob/main/.github/CONTRIBUTING.md) and the following to determine whether or not you have a valid Aesara issue:
11+
12+
- Is there already a GitHub Issue or Discussion for this issue?
13+
14+
If so, please expand upon any specifics of your issue in the existing Issue/Discussion.
15+
16+
- Does your issue only arise in a library that uses Aesara?
17+
18+
If so, please submit your issue to that library's issue tracker first. From there, the Aesara-specific details can be worked out and a valid Aesara issue can be identified. **Issues framed primarily in third-party libraries are liable to being marked as invalid and closed.**
19+
20+
- Does your issue involve OS and/or environment-specific settings (e.g. installation and/or compilation issues)?
21+
22+
If so, please create a [Discussion](https://github.com/aesara-devs/aesara/discussions) instead. From there, we can help determine whether or not the issue is due to faulty logic in Aesara (i.e. a valid issue) or something specific to your local setup.
23+
24+
- type: markdown
25+
attributes:
26+
value: "-----"
27+
- type: textarea
28+
attributes:
29+
label: Expected behavior
30+
description: |
31+
A concise description of what you're trying to do and what you expect to see.
32+
33+
Try to include:
34+
35+
- Minimal, self-contained, and reproducible examples (i.e. an [MWE](https://en.wikipedia.org/wiki/Minimal_reproducible_example)).
36+
- Precise details about the expected output/results (e.g. "The output should consist of the values...").
37+
38+
placeholder: |
39+
I'm trying to compute the ... of ... as follows:
40+
41+
```python
42+
import aesara
43+
import aesara.tensor as at
44+
45+
x = at.vector("x")
46+
...
47+
48+
fn = aesara.function([x], ...)
49+
50+
fn(...)
51+
```
52+
53+
The results should be the value...
54+
validations:
55+
required: true
56+
- type: textarea
57+
attributes:
58+
label: Current behavior
59+
description: |
60+
A concise description of the issue(s) you're observing.
61+
62+
Try to include:
63+
64+
- Any associated output and/or error messages.
65+
- Any attempts you made to resolve the issue yourself, and their result.
66+
placeholder: |
67+
The example above does not return a value and instead raises a `ValueError` error.
68+
69+
Here is the backtrace:
70+
71+
```
72+
ValueError: ...
73+
```
74+
validations:
75+
required: true
76+
- type: input
77+
id: aesara-version
78+
attributes:
79+
label: Aesara Version
80+
description: |
81+
Provide the version of Aesara obtained from `pip show aesara`.
82+
placeholder: 2.x.x
83+
validations:
84+
required: true
85+
- type: input
86+
id: python-version
87+
attributes:
88+
label: Python Version
89+
description: |
90+
Provide the version of Python obtained from `python --version`.
91+
placeholder: 3.8.x
92+
validations:
93+
required: true
94+
- type: input
95+
id: os
96+
attributes:
97+
label: Operating System
98+
description: |
99+
Provide the name of your operating system (e.g. Ubuntu, OSX, Windows).
100+
placeholder: Ubuntu
101+
validations:
102+
required: true
103+
- type: checkboxes
104+
attributes:
105+
label: In which type of virtual environment is Aesara installed?
106+
options:
107+
- label: conda
108+
- label: pip
109+
- type: input
110+
id: aesara-config
111+
attributes:
112+
label: Aesara Config
113+
description: |
114+
Upload the contents of `python -c "import aesara; print(aesara.config)"` to [pastebin](https://pastebin.com), [gist](https://gist.github.com), or a similar service, then provide the link to it here.
115+
placeholder: https://pastebin.com/fakeurl
116+
validations:
117+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Official Documentation
4+
url: https://aesara.readthedocs.io/en/latest/
5+
about: "Provides basic Aesara setup and usage information, as well as design and development outlines"
6+
- name: Visit our Gitter/Matrix Chat
7+
url: https://gitter.im/aesara-devs/aesara
8+
about: "Discuss Aesara in real-time with community members via Gitter/Matrix"
9+
- name: Visit our Discord
10+
url: https://discord.gg/h3sjmPYuGJ
11+
about: "Discuss Aesara in real-time with community members via Discord"

‎.github/ISSUE_TEMPLATE/jax_op_implementation.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: JAX Op Implementation
3+
description: Propose a Numba Op implementation
4+
labels: ["enhancement", "JAX", "Op implementation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
First, carefully read [CONTRIBUTING.md](https://github.com/aesara-devs/aesara/blob/main/.github/CONTRIBUTING.md) and the following:
10+
11+
- Is there already a GitHub Issue requesting this feature?
12+
13+
If so, please contribute to the existing Issue.
14+
15+
- type: markdown
16+
attributes:
17+
value: "-----"
18+
- type: textarea
19+
attributes:
20+
label: Expected behavior
21+
description: |
22+
A concise description of the new/missing `Op` implementation.
23+
24+
placeholder: |
25+
Aesara is missing support for the `Op` ... in JAX.
26+
27+
validations:
28+
required: true

‎.github/ISSUE_TEMPLATE/new_feature_request.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: New Feature Request
3+
description: Propose a new feature
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
First, carefully read [CONTRIBUTING.md](https://github.com/aesara-devs/aesara/blob/main/.github/CONTRIBUTING.md) and the following to determine whether or not you have a valid Aesara feature proposal:
10+
11+
- Is there already a GitHub Issue/Discussion requesting this feature?
12+
13+
If so, please contribute to the existing Issue/Discussion.
14+
15+
- Does the proposed feature involve large-scale, core, and/or design changes to Aesara?
16+
17+
If so, please open a Discussion first so that the Aesara team can provide advice on how to proceed.
18+
19+
- type: markdown
20+
attributes:
21+
value: "-----"
22+
- type: textarea
23+
attributes:
24+
label: Expected behavior
25+
description: |
26+
A concise description of the feature.
27+
28+
Try to include:
29+
30+
- Minimal, self-contained, and reproducible pseudocode examples (i.e. an [MWE](https://en.wikipedia.org/wiki/Minimal_reproducible_example)).
31+
- Precise details about the expected output/results (e.g. "The output should consist of the values...").
32+
33+
placeholder: |
34+
An Aesara function that performs ... would be useful for ...
35+
36+
Here's some pseudocode illustrating the proposed function:
37+
```python
38+
import aesara
39+
import aesara.tensor as at
40+
41+
x = at.vector("x")
42+
...
43+
44+
45+
fn = aesara.function([x], ...)
46+
47+
fn(...)
48+
```
49+
50+
The results should be the value...
51+
validations:
52+
required: true

‎.github/ISSUE_TEMPLATE/numba_op_implementation.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Numba Op Implementation
3+
description: Propose a Numba Op implementation
4+
labels: ["enhancement", "Numba", "Op implementation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
First, carefully read [CONTRIBUTING.md](https://github.com/aesara-devs/aesara/blob/main/.github/CONTRIBUTING.md) and the following:
10+
11+
- Is there already a GitHub Issue requesting this feature?
12+
13+
If so, please contribute to the existing Issue.
14+
15+
- type: markdown
16+
attributes:
17+
value: "-----"
18+
- type: textarea
19+
attributes:
20+
label: Expected behavior
21+
description: |
22+
A concise description of the new/missing `Op` implementation.
23+
24+
placeholder: |
25+
Aesara is missing support for the `Op` ... in Numba.
26+
27+
validations:
28+
required: true

‎.github/ISSUE_TEMPLATE/numpy_compatibility.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: NumPy API Enhancement
3+
description: Propose changes to Aesara's NumPy support
4+
labels: ["enhancement", "NumPy compatibility"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
First, carefully read [CONTRIBUTING.md](https://github.com/aesara-devs/aesara/blob/main/.github/CONTRIBUTING.md) and the following:
10+
11+
- Is there already a GitHub Issue requesting this feature?
12+
13+
If so, please contribute to the existing Issue.
14+
15+
- type: markdown
16+
attributes:
17+
value: "-----"
18+
- type: textarea
19+
attributes:
20+
label: Expected behavior
21+
description: |
22+
A concise description of the new/missing compatibility feature.
23+
24+
Try to include:
25+
26+
- Minimal and self-contained pseudocode examples.
27+
- Precise details about the expected output/results (e.g. "The output should consist of the values...").
28+
29+
placeholder: |
30+
Aesara is missing support for the NumPy function `numpy...`.
31+
32+
validations:
33+
required: true

‎.github/ISSUE_TEMPLATE/scipy_compatibility.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: SciPy API Enhancement
3+
description: Propose changes to Aesara's SciPy support
4+
labels: ["enhancement", "SciPy compatibility"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
First, carefully read [CONTRIBUTING.md](https://github.com/aesara-devs/aesara/blob/main/.github/CONTRIBUTING.md) and the following:
10+
11+
- Is there already a GitHub Issue requesting this feature?
12+
13+
If so, please contribute to the existing Issue.
14+
15+
- type: markdown
16+
attributes:
17+
value: "-----"
18+
- type: textarea
19+
attributes:
20+
label: Expected behavior
21+
description: |
22+
A concise description of the new/missing compatibility feature.
23+
24+
Try to include:
25+
26+
- Minimal and self-contained pseudocode examples.
27+
- Precise details about the expected output/results (e.g. "The output should consist of the values...").
28+
29+
placeholder: |
30+
Aesara is missing support for the SciPy function `scipy...`.
31+
32+
validations:
33+
required: true

0 commit comments

Comments
 (0)