Skip to content

Commit ef12b37

Browse files
Update the GitHub issues template
1 parent 44bd852 commit ef12b37

File tree

3 files changed

+124
-36
lines changed

3 files changed

+124
-36
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 36 deletions
This file was deleted.
Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
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 the following to determine whether or not you have a valid Aesara issue:
11+
12+
- Does your issue only arise in a library that uses Aesara?
13+
14+
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.**
15+
16+
- Does your issue involve OS and/or environment-specific settings (e.g. installation and/or compilation issues)?
17+
18+
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.
19+
20+
- type: markdown
21+
attributes:
22+
value: "-----"
23+
- type: textarea
24+
attributes:
25+
label: Expected behavior
26+
description: |
27+
A concise description of what you're trying to do and what you expect to see.
28+
29+
Try to include:
30+
31+
- Minimal, self-contained, and reproducible examples (i.e. an [MWE](https://en.wikipedia.org/wiki/Minimal_reproducible_example)).
32+
- Precise details about the expected output/results (e.g. "The output should consist of the values...").
33+
34+
placeholder: |
35+
I'm trying to compute the ... of ... as follows:
36+
37+
```python
38+
import aesara
39+
import aesara.tensor as at
40+
41+
x = at.vector("x")
42+
...
43+
44+
fn = aesara.function([x], ...)
45+
46+
fn(...)
47+
```
48+
49+
The results should be the value...
50+
validations:
51+
required: true
52+
- type: textarea
53+
attributes:
54+
label: Current behavior
55+
description: |
56+
A concise description of the issue(s) you're observing.
57+
58+
Try to include:
59+
60+
- Any associated output and/or error messages.
61+
- Any attempts you made to resolve the issue yourself, and their result.
62+
placeholder: |
63+
The example above does not return a value and instead raises a `ValueError` error.
64+
65+
Here is the backtrace:
66+
67+
```
68+
ValueError: ...
69+
```
70+
validations:
71+
required: true
72+
- type: input
73+
id: aesara-version
74+
attributes:
75+
label: Aesara Version
76+
description: |
77+
Provide the version of Aesara obtained from `pip show aesara`.
78+
placeholder: 2.x.x
79+
validations:
80+
required: true
81+
- type: input
82+
id: python-version
83+
attributes:
84+
label: Python Version
85+
description: |
86+
Provide the version of Python obtained from `python --version`.
87+
placeholder: 3.8.x
88+
validations:
89+
required: true
90+
- type: input
91+
id: os
92+
attributes:
93+
label: Operating System
94+
description: |
95+
Provide the name of your operating system (e.g. Ubuntu, OSX, Windows).
96+
placeholder: Ubuntu
97+
validations:
98+
required: true
99+
- type: checkboxes
100+
attributes:
101+
label: In which type of virtual environment is Aesara installed?
102+
options:
103+
- label: conda
104+
- label: pip
105+
- type: input
106+
id: aesara-config
107+
attributes:
108+
label: Aesara Config
109+
description: |
110+
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.
111+
placeholder: https://pastebin.com/fakeurl
112+
validations:
113+
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."

0 commit comments

Comments
 (0)