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.

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

🫴 Better guide users in error reporting #2327

Merged
merged 8 commits into from
Nov 11, 2024
Merged

🫴 Better guide users in error reporting #2327

merged 8 commits into from
Nov 11, 2024

Conversation

qgallouedec
Copy link
Member

@qgallouedec qgallouedec commented Nov 5, 2024

What does this PR do?

One out of every two issues submitted doesn’t meet the requirements in the issue template or contributing guidelines—often missing system information (#2316, #2314, #2268, #2299), containing incomplete (#2314, #2268, #2217, #2299) or unformatted code (#2316, #2314, #2268, #2205, #2299), or lacking full traceback details (#2294, #2268, #2299). This suggests many users may skip the instructions entirely.

In my experience, using checkboxes is a subtle way to make the process more engaging and to encourage users to review each item. Checking a box doesn’t take extra effort, but it helps everyone stay on track.

Proposal


Before submitting, please confirm that you've completed each of the following:

  • I have checked that my issue isn’t already filed (see open issues)
  • I have included my system information
  • Any code provided is minimal, complete, and reproducible (more on MREs)
  • Any code provided is properly formatted in code blocks (more on code blocks)
  • Any traceback provided is complete

If an item doesn’t apply to your issue, check it anyway to show you've reviewed it.


Demo: https://github.com/qgallouedec/super-happiness/issues/new/choose

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a GitHub issue? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

@qgallouedec qgallouedec changed the title update issue template 🫴 Better guide users in error reporting Nov 5, 2024
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@qgallouedec qgallouedec marked this pull request as ready for review November 5, 2024 11:55
@qgallouedec qgallouedec merged commit 518e29c into main Nov 11, 2024
14 checks passed
@qgallouedec qgallouedec deleted the issue-template branch November 11, 2024 12:42
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.

3 participants