Skip to content

Add template for bug reports #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LTMeyer merged 6 commits into from
May 21, 2025
Merged

Add template for bug reports #42

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9a122ef
Add template for bug reports
LTMeyer Apr 7, 2025
e7cecff
Update already existing issue message
LTMeyer Apr 8, 2025
ed3d93e
Add version and environment to issue template
LTMeyer May 20, 2025
360b78b
Merge branch 'public' into add-issue-template
LTMeyer May 20, 2025
c8c7a6b
Add code snippet to obtain version and environment
LTMeyer May 20, 2025
4269d25
Fix typo in code snippet
LTMeyer May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Bug Report
description: Create a report to help us reproduce and fix the bug
title: "[Bug]: "
labels: ["bug"]

body:
- type: markdown
attributes:
value: >
Thank you for taking the time to file a bug report.
Before creating a new issue, you can have a quick look to the [FAQ](https://github.com/PolymathicAI/the_well/discussions/categories/q-a?discussions_q=category%3AQ%26A+) and [existing issues](https://github.com/PolymathicAI/the_well/issues).
- type: textarea
attributes:
label: "Describe the issue:"
placeholder: |
<< your issue description here >>
validations:
required: true
- type: textarea
attributes:
label: "Code to reproduce the issue:"
description: >
A short code example that reproduces the problem/missing feature.
It should be self-contained.
placeholder: |
<< your code here >>
render: python
validations:
required: true
- type: textarea
attributes:
label: "Version"
description: |
Which version of the Well are you using?
You can obtain the version by running the following command:
```sh
python -c "import the_well; print(the_well.__version__)"
```
placeholder: |
<< your version here >>
validations:
required: true
- type: textarea
attributes:
label: "Environment"
description: |
Which environment are you using? List the packages you have installed along the Well.
In case you use pip, you can obtain the list of installed packages by running the following command:
```sh
pip freeze
```
placeholder: |
<< your environment here >>
validations:
required: true
- type: textarea
attributes:
label: "Context for the issue:"
description: |
Please explain how this issue affects your intended use of the Well.
You can also provide additional context that you think might be relevant.
placeholder: |
<< your explanation here >>
validations:
required: false
Loading