-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Proposed template for bug reporting (#226)
- Loading branch information
1 parent
892a3f9
commit 83395e9
Showing
2 changed files
with
70 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
name: Bug report | ||
description: Report to help us reproduce the bug | ||
title: "[Bug]: " | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
## Thanks for taking the time to fill out this report | ||
- type: markdown | ||
attributes: | ||
value: > | ||
### Before submitting a bug, please make sure it has not been reported in the | ||
[list of issues](https://github.com/narwhals-dev/narwhals/issues). | ||
- type: textarea | ||
attributes: | ||
label: Describe the bug | ||
description: > | ||
A clear description of the bug. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Steps or code to reproduce the bug | ||
description: | | ||
Please add a minimal code example to reproduce the bug. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Expected results | ||
description: > | ||
Please paste or describe the expected results. | ||
placeholder: > | ||
Example: No error is thrown. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Actual results | ||
description: | | ||
Please paste or describe the results you observe instead of the expected results. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Versions | ||
render: shell | ||
description: | | ||
What version of Narwhals and dataframe libraries are you running? | ||
You could run the following and provide the output below. | ||
``` | ||
pip freeze | grep -E "narwhals|polars|pandas|modin|cudf" | ||
``` | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Relevant log output | ||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
render: shell |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
contact_links: | ||
- name: Discord server | ||
url: https://discord.gg/V3PqtB4VA4) | ||
about: | | ||
Developers and users can be found on the Discord server. | ||
Please note that GitHub Discussions should be used in most cases instead. | ||
- name: Blank issue | ||
url: https://github.com/narwhals-dev/narwhals/issues/new | ||
|