Unverified 提交 4bd9247b authored 作者: Maxim Kochurov's avatar Maxim Kochurov 提交者: GitHub

Issue template (#8)

* Add issue templates based on NumPy issue templates Closes #7 Co-authored-by: 's avatarMaxim Kochurov <m.kochurov@ntechlab.com> Co-authored-by: 's avatarMichael Osthege <michael.osthege@outlook.com>
上级 a1d3e956
## Description of your problem or feature request
First, carefully read the following to determine whether or not you have a valid Pytensor issue:
- Does your issue only arise in a library that uses Pytensor (e.g. PyMC)? If so, submit your issue to that library's issue tracker. From there, the Pytensor-specific details can be worked out and a valid Pytensor issue can be identified. **Issues framed primarily in third-party libraries are liable to being marked as invalid and closed.**
- Does your issue involve OS and/or environment-specific settings (e.g. installation and/or compilation issues)? If so, create a [Discussion](https://github.com/pymc-devs/pytensor/discussions) instead. From there, we can help determine whether or not the issue is due to faulty logic in Pytensor (i.e. a valid issue) or something specific to your local setup.
If the above does not apply, and you have an issue or feature request that's specific to Pytensor, provide a minimal, self-contained, and reproducible example (i.e. an [MWE](https://en.wikipedia.org/wiki/Minimal_reproducible_example)):
```python
[Your code here]
```
**Please provide the full tracebacks for any relevant errors and/or warning messages.**
```python
[The error output here]
```
**Please provide any additional information below.**
## Versions and main components
* Pytensor version:
* Python version:
* Operating system:
* How did you install Pytensor: (conda/pip)
<details> <summary> Pytensor config: </summary>
Place the results of `python -c "import pytensor; print(pytensor.config)"` here.
</details>
# This issue template was adapted from the NumPy project
# under the BSD 3-Clause "New" or "Revised" License.
# Copyright (c) 2005-2022, NumPy Developers.
# All rights reserved.
name: Bug report
description: Report a bug. For security vulnerabilities see Report a security vulnerability in the templates.
title: "BUG: <Please write a comprehensive title after the 'BUG: ' prefix>"
labels: [bug]
body:
- type: markdown
attributes:
value: >
Thank you for taking the time to file a bug report. Before creating a new
issue, please make sure to take a few minutes to check the issue tracker
for existing issues about the bug. If you do not face a bug but rather a
general question, please create a discussion thread at
[Discussion](https://github.com/pymc-devs/pytensor/discussions)
- type: textarea
attributes:
label: "Describe the issue:"
validations:
required: true
- type: textarea
attributes:
label: "Reproducable code example:"
description: >
A short code example that reproduces the problem/missing feature. It
should be self-contained, i.e., can be copy-pasted into the Python
interpreter or run as-is via `python myproblem.py`.
placeholder: |
import pytensor
import pytensor.tensor as pt
<< your code here >>
render: python
validations:
required: true
- type: textarea
attributes:
label: "Error message:"
description: >
Please include the full error message below.
placeholder: |
<details>
<< Full traceback starting from `Traceback: ...` >>
</details>
render: shell
- type: textarea
attributes:
label: "Pytensor version information:"
description: >
Pytensor Version:
Python Version:
Operating system:
How did you install pytensor: (conda/pip)
Specific config for the issue if any
(you may use `python -c "import pytensor; print(pytensor.config)"`
to get it and enclose in `<details>` `</details>`)
placeholder: |
<details>
configuration information
</details>
validations:
required: true
- type: textarea
attributes:
label: "Context for the issue:"
description: |
Please explain how this issue affects your work or why it should be prioritized.
placeholder: |
<< your explanation here >>
validations:
required: false
blank_issues_enabled: false
contact_links:
- name: PyMC Discourse
url: https://discourse.pymc.io/
about: Ask usage questions about PyMC or Pytensor
# This issue template was adapted from the NumPy project
# under the BSD 3-Clause "New" or "Revised" License.
# Copyright (c) 2005-2022, NumPy Developers.
# All rights reserved.
name: Documentation
description: Report an issue related to the Pytensor documentation.
title: "DOC: <Please write a comprehensive title after the 'DOC: ' prefix>"
labels: [docs]
body:
- type: textarea
attributes:
label: "Issue with current documentation:"
description: >
Please make sure to leave a reference to the document/code you're
referring to. You can also check the development version of the
documentation and see if this issue has already been addressed at
https://pytensor.readthedocs.io/en/latest/.
validations:
required: true
- type: textarea
attributes:
label: "Idea or request for content:"
description: >
Please describe as clearly as possible what topics you think are missing
from the current documentation.
# This issue template was adapted from the NumPy project
# under the BSD 3-Clause "New" or "Revised" License.
# Copyright (c) 2005-2022, NumPy Developers.
# All rights reserved.
name: Feature request
description: Check instructions for submitting your idea on the mailing list first.
title: "ENH: <Please write a comprehensive title after the 'ENH: ' prefix>"
labels: [enhancements]
body:
- type: markdown
attributes:
value: >
If you're looking to request a new feature or change in functionality,
including adding or changing the meaning of arguments to an existing
function, please post your idea first on please create a discussion thread at
[Discussions](https://github.com/pymc-devs/pytensor/discussions)
to validate it and bring attention to it. After validation,
you can open this issue for a more technical developer discussion.
Check the [Contributor Guide](https://github.com/pymc-devs/pytensor/blob/main/CONTRIBUTING.md)
if you need more information.
- type: textarea
attributes:
label: "Link to a discussion"
descrition: >
Link to the discussion about this feature request in
[Discussions](https://github.com/pymc-devs/pytensor/discussions)
validations:
required: true
- type: textarea
attributes:
label: "Before"
descrition: >
Please fill the code snippet: How did you workaround your problem or frequent use?
Leave empty if you found no workaround.
validations:
required: false
render: python
- type: textarea
attributes:
label: "After"
descrition: >
How you see it implemented with a high level API without going into details
validations:
required: false
render: python
- type: textarea
attributes:
label: "Context for the issue:"
description: |
Please explain how this issue affects your work, why it should be prioritized
or add any information that did not fit Before After template.
placeholder: |
<< your explanation here >>
validations:
required: false
# This issue template was adapted from the NumPy project
# under the BSD 3-Clause "New" or "Revised" License.
# Copyright (c) 2005-2022, NumPy Developers.
# All rights reserved.
name: Post-install/importing issue
description: Report an issue if you have trouble importing or using Pytensor after installation.
title: "<Please write a comprehensive title here>"
labels: [installation]
body:
- type: textarea
attributes:
label: "Steps to reproduce:"
description: >
Please describe the installation method (e.g. building from source,
Anaconda, pip), your OS and pytensor/Python version information.
validations:
required: true
- type: textarea
attributes:
label: "Error message:"
description: >
Please include full error message.
placeholder: |
<< Full traceback starting from `Traceback: ...` >>
render: shell
- type: textarea
attributes:
label: "Additional information:"
description: Please add any additional information that could help us diagnose the problem better.
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论