Skip to content

Commit eb16ce6

Browse files
ferrinemichaelosthege
ferrine
and
michaelosthege
authored
Add issue templates (#6327)
* New templates, and refined templates based on those from NumPy Co-authored-by: Maxim Kochurov <max.kochurov@pymc-devs.org> Co-authored-by: Michael Osthege <michael.osthege@outlook.com>
1 parent 24b93c4 commit eb16ce6

File tree

5 files changed

+198
-33
lines changed

5 files changed

+198
-33
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
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: [defects]
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.
18+
19+
- type: textarea
20+
attributes:
21+
label: "Describe the issue:"
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
attributes:
27+
label: "Reproduceable code example:"
28+
description: >
29+
A short code example that reproduces the problem/missing feature. It
30+
should be self-contained, i.e., can be copy-pasted into the Python
31+
interpreter or run as-is via `python myproblem.py`.
32+
placeholder: |
33+
import pymc as pm
34+
<< your code here >>
35+
render: python
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
attributes:
41+
label: "Error message:"
42+
description: >
43+
Please include full error message, if any.
44+
placeholder: |
45+
<details>
46+
Full traceback starting from `Traceback: ...`
47+
</details>
48+
render: shell
49+
50+
- type: textarea
51+
attributes:
52+
label: "PyMC version information:"
53+
description: >
54+
PyMC/PyMC3 Version:
55+
Aesara/Theano Version:
56+
Python Version:
57+
Operating system:
58+
How did you install PyMC/PyMC3: (conda/pip)
59+
placeholder: |
60+
<details>
61+
configuration information
62+
</details>
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
attributes:
68+
label: "Context for the issue:"
69+
description: |
70+
Please explain how this issue affects your work or why it should be prioritized.
71+
placeholder: |
72+
<< your explanation here >>
73+
validations:
74+
required: false

‎.github/ISSUE_TEMPLATE/bug_report.md

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

‎.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 PyMC 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://www.pymc.io/projects/docs/en/latest/api.html.
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: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
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: Make a specific, well-motivated proposal for a feature.
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 as a [Discussion](https://github.com/pymc-devs/pymc/discussions)
19+
to validate it and bring attention to it. After validation,
20+
you can open this issue for a more technical developer discussion.
21+
Check the [Contributor Guide](https://github.com/pymc-devs/pymc/blob/main/CONTRIBUTING.md)
22+
if you need more information.
23+
24+
- type: textarea
25+
attributes:
26+
label: "Link to a discussion"
27+
descrition: >
28+
Link to the discussion about this feature request in
29+
[Discussions](https://github.com/pymc-devs/pymc/discussions)
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
attributes:
35+
label: "Before"
36+
descrition: >
37+
Please fill the code snippet: How did you workaround your problem or frequent use?
38+
Leave empty if you found no workaround.
39+
validations:
40+
required: false
41+
render: python
42+
43+
- type: textarea
44+
attributes:
45+
label: "After"
46+
descrition: >
47+
How you see it implemented with a high level API without going into details
48+
validations:
49+
required: false
50+
render: python
51+
52+
- type: textarea
53+
attributes:
54+
label: "Context for the issue:"
55+
description: |
56+
Please explain how this issue affects your work, why it should be prioritized
57+
or add any information that did not fit Before After template.
58+
placeholder: |
59+
<< your explanation here >>
60+
validations:
61+
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 PyMC 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 PyMC/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)