Skip to content

Commit

Permalink
Add enhanced bug report template
Browse files Browse the repository at this point in the history
  • Loading branch information
jakevdp committed Aug 4, 2022
1 parent e1b31f8 commit 945adfd
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 19 deletions.
18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/Bug_report.md

This file was deleted.

55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
name: Bug report
description: >-
Report a bug or unexpected behavior to help us improve the package
title: 'BUG: '
labels:
- bug

body:
- type: markdown
attributes:
value: >
**Thank you for helping us improve JAX!**
Please first verify that your issue is not already reported using the
[Issue search][issue search].
If you are asking a question or seeking support, please
consider [starting a discussion][Discussions].
If you prefer a non-templated issue report, click [here][Raw report].
[Discussions]: https://github.com/google/jax/discussions
[issue search]: https://github.com/google/jax/search?q=is%3Aissue&type=issues
[Raw report]: http://github.com/google/jax/issues/new
- type: textarea
attributes:
label: Description
description: >-
A concise description of the bug, preferably including self-contained
code to reproduce the issue.
placeholder: |
Text may use markdown formatting.
```python
# for codeblocks, use triple backticks
```
validations:
required: true
- type: input
attributes:
label: What jax/jaxlib version are you using?
placeholder: For example: jax v0.3.0; jaxlib v0.3.0
- type: checkboxes
attributes:
label: Which accelerator(s) are you using?
options:
- label: CPU
- label: GPU
- label: TPU
- type: input
attributes:
label: Additional System Info
placeholder: Linux, Mac, Windows; Python version; etc.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Question
- name: Have questions or need support?
url: https://github.com/google/jax/discussions
about: Please ask questions on the Discussions tab

0 comments on commit 945adfd

Please sign in to comment.