search

huggingface / huggingface.js

Utilities to use the Hugging Face Hub API
https://hf.co/docs/huggingface.js
MIT License
1.37k stars 213 forks source link

PR template when adding a new library #913

Closed Wauplin closed 2 weeks ago

Wauplin commented 2 weeks ago

This PR adds a template with a checklist to follow when adding a new library.

Based on https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository.

Once merged, we should be able to generate a link to create such a PR (the template will not be used by default for all PRs :smile:). This link would be added to https://huggingface.co/docs/hub/models-download-stats#can-i-add-my-query-files-for-my-library.

Hopefully, this should reduce the back-and-fourth when someone adds a new library. I suggest we start with that as an experiment and if it doesn't work, we can move it somewhere else as documentation.

Wauplin commented 2 weeks ago

I've addressed feedback in https://github.com/huggingface/huggingface.js/pull/913/commits/b54ffcce546f703f087e071300212e00a579559c. I have added "(optional)" in the snippets title to make it clear it's optional. Let's merge it as it is and reassess after if needed.

Wauplin commented 2 weeks ago

Well, I've been enthusiastic a bit too quickly... This feature requires the user to manually edit their URL to make it work >< . I'll try to hack something based on https://stackoverflow.com/questions/73771068/multiple-templates-for-pull-requests-on-github