Skip to content
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.

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

Update the issue templates #409

Merged
merged 1 commit into from
Nov 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
50 changes: 0 additions & 50 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Issue template inspired by NumPy's excellent template:
# https://github.com/numpy/numpy/edit/main/.github/ISSUE_TEMPLATE/bug-report.yml
name: Bug report
description: Create a bug report to help us reproduce and correct it.
title: "<Please write a descriptive title>"
labels: [00 - 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 open and closed issues that may be related to your bug.

- type: textarea
attributes:
label: "Describe the issue as clearly as possible:"
validations:
required: true

- type: textarea
attributes:
label: "Steps/code to reproduce the bug:"
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 blackjax
<< your code here >>
render: python
validations:
required: true

- type: textarea
attributes:
label: "Expected result:"
description: >
Please describe what you expect the above example to output.
placeholder: |
<< the expected result here >>
render: shell
validations:
required: true

- type: textarea
attributes:
label: "Error message:"
description: >
Please include the full error message, if any.
placeholder: |
<< Full traceback starting from `Traceback: ...` >>
render: shell

- type: textarea
attributes:
label: "Blackjax/JAX/jaxlib/Python version information:"
description: Please run the following code and paste the output here.
placeholder: |
import blackjax; print("BlackJAX", blackjax.__version__)
import sys; print("Python", sys.version)
import jax; print("Jax", jax.__version__)
import jaxlib; print("Jaxlib", jaxlib.__version__)
render: python
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
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Question/Help/Support
url: https://github.com/blackjax-devs/blackjax/discussions/new
about: "If you have a question about how to use Blackjax, please start a discussion."
9 changes: 0 additions & 9 deletions .github/ISSUE_TEMPLATE/how_to.md

This file was deleted.