Skip to content

Conversation

jsulz
Copy link
Collaborator

@jsulz jsulz commented Jun 5, 2025

This PR adds:

  • bug-report.yml - an issue form for bug reports (will likely need to be extended/changed as new clients are added; for now it is very Python-centric)
  • feature-request.yml - an issue form for feature requests
  • config.yml - additional links that people will see when clicking on "New Issue" - see https://github.com/huggingface/huggingface_hub/issues -> New Issue for an example

The .yml files and directory structure follow the issue form syntax/structure described here https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms

A lot of this was lifted from the way the huggingface_hub repository structures these templates - see here: https://github.com/huggingface/huggingface_hub/tree/main/.github/ISSUE_TEMPLATE - and then modified for some of the more common things we ask (machine info; HF_XET envvars, etc)

This symmetry between huggingface_hub and this repo was intentional so community members aren't started by a completely different format for providing information when opening an issue/asking for a feature.

@jsulz jsulz requested review from hoytak, rajatarya and assafvayner June 5, 2025 20:05
Copy link
Contributor

@assafvayner assafvayner left a comment

Choose a reason for hiding this comment

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

:shipit:

@jsulz jsulz merged commit dd95412 into main Jun 6, 2025
4 checks passed
@jsulz jsulz deleted the jsulz/issue-templates branch June 6, 2025 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants