From 32cb9e9d7c3720974e72fae2b08a24fd8b33bd00 Mon Sep 17 00:00:00 2001 From: "Brandon T. Willard" Date: Mon, 17 Oct 2022 13:36:59 -0500 Subject: [PATCH] Mention common cases in issue template --- .github/ISSUE_TEMPLATE.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index b01842ab2c..48aea59864 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,11 +1,20 @@ ## Description of your problem or feature request -**Please provide a minimal, self-contained, and reproducible example.** +First, carefully read the following to determine whether or not you have a valid Aesara issue: + +- Does your issue only arise in a library that uses Aesara (e.g. PyMC)? If so, submit your issue to that library's issue tracker. From there, the Aesara-specific details can be worked out and a valid Aesara issue can be identified. +- 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/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. + + +If the above does not apply, and you have an issue or feature request that's specific to Aesara, 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 traceback of any errors.** +**Please provide the full tracebacks for any relevant errors and/or warning messages.** + + ```python [The error output here] ``` @@ -16,7 +25,12 @@ ## Versions and main components * Aesara version: -* Aesara config (`python -c "import aesara; print(aesara.config)"`) * Python version: * Operating system: * How did you install Aesara: (conda/pip) + +
Aesara config: + +Place the results of `python -c "import aesara; print(aesara.config)"` here. + +