Skip to content

Commit 4bd9247

Browse files
ferrineMaxim Kochurovmichaelosthege
authored
Issue template (#8)
* Add issue templates based on NumPy issue templates Closes #7 Co-authored-by: Maxim Kochurov <[email protected]> Co-authored-by: Michael Osthege <[email protected]>
1 parent a1d3e95 commit 4bd9247

File tree

6 files changed

+209
-36
lines changed

6 files changed

+209
-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: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# This issue template was adapted from the NumPy project
2+
# under the BSD 3-Clause "New" or "Revised" License.
3+
# Copyright (c) 2005-2022, NumPy Developers.
4+
# All rights reserved.
5+
6+
name: Bug report
7+
description: Report a bug. For security vulnerabilities see Report a security vulnerability in the templates.
8+
title: "BUG: <Please write a comprehensive title after the 'BUG: ' prefix>"
9+
labels: [bug]
10+
11+
body:
12+
- type: markdown
13+
attributes:
14+
value: >
15+
Thank you for taking the time to file a bug report. Before creating a new
16+
issue, please make sure to take a few minutes to check the issue tracker
17+
for existing issues about the bug. If you do not face a bug but rather a
18+
general question, please create a discussion thread at
19+
[Discussion](https://github.com/pymc-devs/pytensor/discussions)
20+
21+
- type: textarea
22+
attributes:
23+
label: "Describe the issue:"
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
attributes:
29+
label: "Reproducable code example:"
30+
description: >
31+
A short code example that reproduces the problem/missing feature. It
32+
should be self-contained, i.e., can be copy-pasted into the Python
33+
interpreter or run as-is via `python myproblem.py`.
34+
placeholder: |
35+
import pytensor
36+
import pytensor.tensor as pt
37+
<< your code here >>
38+
render: python
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
attributes:
44+
label: "Error message:"
45+
description: >
46+
Please include the full error message below.
47+
placeholder: |
48+
<details>
49+
<< Full traceback starting from `Traceback: ...` >>
50+
</details>
51+
render: shell
52+
53+
- type: textarea
54+
attributes:
55+
label: "Pytensor version information:"
56+
description: >
57+
Pytensor Version:
58+
Python Version:
59+
Operating system:
60+
How did you install pytensor: (conda/pip)
61+
Specific config for the issue if any
62+
(you may use `python -c "import pytensor; print(pytensor.config)"`
63+
to get it and enclose in `<details>` `</details>`)
64+
placeholder: |
65+
<details>
66+
configuration information
67+
</details>
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
attributes:
73+
label: "Context for the issue:"
74+
description: |
75+
Please explain how this issue affects your work or why it should be prioritized.
76+
placeholder: |
77+
<< your explanation here >>
78+
validations:
79+
required: false

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: PyMC Discourse
4+
url: https://discourse.pymc.io/
5+
about: Ask usage questions about PyMC or Pytensor

‎.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# This issue template was adapted from the NumPy project
2+
# under the BSD 3-Clause "New" or "Revised" License.
3+
# Copyright (c) 2005-2022, NumPy Developers.
4+
# All rights reserved.
5+
6+
7+
name: Documentation
8+
description: Report an issue related to the Pytensor documentation.
9+
title: "DOC: <Please write a comprehensive title after the 'DOC: ' prefix>"
10+
labels: [docs]
11+
12+
body:
13+
- type: textarea
14+
attributes:
15+
label: "Issue with current documentation:"
16+
description: >
17+
Please make sure to leave a reference to the document/code you're
18+
referring to. You can also check the development version of the
19+
documentation and see if this issue has already been addressed at
20+
https://pytensor.readthedocs.io/en/latest/.
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
attributes:
26+
label: "Idea or request for content:"
27+
description: >
28+
Please describe as clearly as possible what topics you think are missing
29+
from the current documentation.

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# This issue template was adapted from the NumPy project
2+
# under the BSD 3-Clause "New" or "Revised" License.
3+
# Copyright (c) 2005-2022, NumPy Developers.
4+
# All rights reserved.
5+
6+
name: Feature request
7+
description: Check instructions for submitting your idea on the mailing list first.
8+
title: "ENH: <Please write a comprehensive title after the 'ENH: ' prefix>"
9+
labels: [enhancements]
10+
11+
12+
body:
13+
- type: markdown
14+
attributes:
15+
value: >
16+
If you're looking to request a new feature or change in functionality,
17+
including adding or changing the meaning of arguments to an existing
18+
function, please post your idea first on please create a discussion thread at
19+
[Discussions](https://github.com/pymc-devs/pytensor/discussions)
20+
to validate it and bring attention to it. After validation,
21+
you can open this issue for a more technical developer discussion.
22+
Check the [Contributor Guide](https://github.com/pymc-devs/pytensor/blob/main/CONTRIBUTING.md)
23+
if you need more information.
24+
25+
- type: textarea
26+
attributes:
27+
label: "Link to a discussion"
28+
descrition: >
29+
Link to the discussion about this feature request in
30+
[Discussions](https://github.com/pymc-devs/pytensor/discussions)
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
attributes:
36+
label: "Before"
37+
descrition: >
38+
Please fill the code snippet: How did you workaround your problem or frequent use?
39+
Leave empty if you found no workaround.
40+
validations:
41+
required: false
42+
render: python
43+
44+
- type: textarea
45+
attributes:
46+
label: "After"
47+
descrition: >
48+
How you see it implemented with a high level API without going into details
49+
validations:
50+
required: false
51+
render: python
52+
53+
- type: textarea
54+
attributes:
55+
label: "Context for the issue:"
56+
description: |
57+
Please explain how this issue affects your work, why it should be prioritized
58+
or add any information that did not fit Before After template.
59+
placeholder: |
60+
<< your explanation here >>
61+
validations:
62+
required: false

‎.github/ISSUE_TEMPLATE/installation.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# This issue template was adapted from the NumPy project
2+
# under the BSD 3-Clause "New" or "Revised" License.
3+
# Copyright (c) 2005-2022, NumPy Developers.
4+
# All rights reserved.
5+
6+
7+
name: Post-install/importing issue
8+
description: Report an issue if you have trouble importing or using Pytensor after installation.
9+
title: "<Please write a comprehensive title here>"
10+
labels: [installation]
11+
12+
body:
13+
- type: textarea
14+
attributes:
15+
label: "Steps to reproduce:"
16+
description: >
17+
Please describe the installation method (e.g. building from source,
18+
Anaconda, pip), your OS and pytensor/Python version information.
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
attributes:
24+
label: "Error message:"
25+
description: >
26+
Please include full error message.
27+
placeholder: |
28+
<< Full traceback starting from `Traceback: ...` >>
29+
render: shell
30+
31+
- type: textarea
32+
attributes:
33+
label: "Additional information:"
34+
description: Please add any additional information that could help us diagnose the problem better.

0 commit comments

Comments
 (0)