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.

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

Add a bug report template #832

Merged
merged 5 commits into from
Apr 15, 2022
Merged

Add a bug report template #832

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e8f9b1a
Add bug report template
osanseviero Apr 11, 2022
cbeb2b8
Change extension
osanseviero Apr 11, 2022
e0d93fc
Merge branch 'main' into cleanup_things
adrinjalali Apr 14, 2022
e739f2f
Update .github/ISSUE_TEMPLATE/bug-report.yml
osanseviero Apr 15, 2022
6910767
Update .github/ISSUE_TEMPLATE/bug-report.yml
osanseviero Apr 15, 2022
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
37 changes: 37 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,37 @@
name: "\U0001F41B Bug Report"
description: Report a bug on huggingface_hub
labels: [ "bug" ]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
osanseviero marked this conversation as resolved.
Show resolved Hide resolved
placeholder: Bug description
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction
description: Please provide a code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet.
osanseviero marked this conversation as resolved.
Show resolved Hide resolved
placeholder: Reproduction
- type: textarea
id: logs
attributes:
label: Logs
description: "Please include the Python logs if you can."
render: shell
- type: textarea
id: system-info
attributes:
label: System Info
description: Please share your system info with us,
render: shell
placeholder: huggingface_hub version, Python Version, etc
Comment on lines +31 to +35
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For this it would be super nice to have a huggingface-cli env command like we do for other libraries.

If you feel like doing it, we follow roughly the same structure as transformers in terms of commands, and it is visible here, registered here.

Not necessary for this PR to be merged though.

validations:
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Feature request
name: "\U0001F680 Feature request"
about: Suggest an idea for this project
title: ''
labels: ''
Expand Down