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

github: disable blank issues without an issue template #814

Merged
merged 1 commit into from
Aug 23, 2020

Conversation

agilgur5
Copy link
Collaborator

Description

Tags

#761 pointed out to me that one could click a button for a blank issue which was what led me to find these docs and this config option. Should help pare down on issues labeled with "removed issue template" more broadly

- apparently there's a button you can press to skip using an issue
  template, which means some issues come in that can be low quality,
  confusing what the request is, don't list versions, etc
  - so disable this button and require a template, which will also make
    the writer think about whether their issue is a feature or bug
    - (if neither, perhaps StackOverflow, Discussions, etc is a better
      option than filing an issue)

- follows the official docs from
  https://docs.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser,
  which instructs to set blank_issues_enabled to false to disable the
  button / option
@vercel
Copy link

vercel bot commented Aug 23, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/formium/tsdx/6hlnr1lbd
✅ Preview: https://tsdx-git-fork-agilgur5-no-blank-issues.formium.vercel.app

Copy link
Collaborator Author

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

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

From the website / docs:

You can customize the issue template chooser that people see when creating a new issue in your repository by adding a config.yml file to the .github/ISSUE_TEMPLATE folder

You can encourage contributors to use issue templates by setting blank_issues_enabled to false.

So seems about right to me 👍

@agilgur5 agilgur5 merged commit 0139cae into jaredpalmer:master Aug 23, 2020
@agilgur5
Copy link
Collaborator Author

Setting seems to be working:

Screen Shot 2020-08-22 at 11 45 52 PM

paul-vd pushed a commit to EezyQuote/tsdx that referenced this pull request Dec 1, 2020
- apparently there's a button you can press to skip using an issue
  template, which means some issues come in that can be low quality,
  confusing what the request is, don't list versions, etc
  - so disable this button and require a template, which will also make
    the writer think about whether their issue is a feature or bug
    - (if neither, perhaps StackOverflow, Discussions, etc is a better
      option than filing an issue)

- follows the official docs from
  https://docs.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser,
  which instructs to set blank_issues_enabled to false to disable the
  button / option
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.

1 participant