Skip to content

Remove bug template from blank issue template - was not kept in sync#15328

Merged
seanbudd merged 2 commits into
masterfrom
removeOutDateIssueTemplate
Aug 25, 2023
Merged

Remove bug template from blank issue template - was not kept in sync#15328
seanbudd merged 2 commits into
masterfrom
removeOutDateIssueTemplate

Conversation

@seanbudd

@seanbudd seanbudd commented Aug 24, 2023

Copy link
Copy Markdown
Member

Summary of the issue:

GitHub has an issue where even though we disable opening blank issues, they can still be created.
If a GitHub user reaches the page: https://github.com/nvaccess/nvda/issues/new, .github/ISSUE_TEMPLATE.md is rendered.
It is uncertain where this page is linked from, as the preferred and main UX is where you choose an issue https://github.com/nvaccess/nvda/issues/new/choose.

An older copy of the issue template is kept in the blank issue template.
This is not kept in sync with the main bug report issue template.
It also misses a lot of information from the main bug report issue template.

Description of user facing changes

Remove the duplicate bug report template from the blank issue template.
Instead encourage using issue templates correctly.

More information on the GitHub bug

The bug with GitHub has been reported privately

The documentation for disabling blank issues is misleading - the behaviour of blank_issues_enabled could be improved further.

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser

You can encourage contributors to use issue templates by setting blank_issues_enabled to false. If you set blank_issues_enabled to true, people will have the option to open a blank issue.

Note: If you used the legacy workflow to manually create an issue_template.md file in the .github folder and enable blank issues in your config.yml file, the template in issue_template.md will be used when people chose to open a blank issue. If you disable blank issues, the template will never be used.

This is not true. A repository can always have a blank issue opened against it, regardless if blank_issues_enabled=false.
The url https://github.com/org/repo/issues/new is always accessible.
Instead it should redirect to https://github.com/org/repo/issues/new/choose if blank_issues_enabled=false.

Response from GitHub

I'm afraid that currently, issue templates are treated as more of a "suggestion" than a hard requirement. The blank_issues_enabled field only prevents a button for a blank issue showing up on the issue chooser, but does not prevent blank issues entirely. Our team is aware that this behavior is confusing/misleading and is considering how they want to move forward. I've added your report to our internal issue as another data point.

@seanbudd seanbudd requested a review from a team as a code owner August 24, 2023 03:16
@seanbudd seanbudd changed the title Remove issue template from blank issue template - was not kept in sync Remove bug template from blank issue template - was not kept in sync Aug 24, 2023
@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit 8f3cdcaa20

@seanbudd seanbudd merged commit 1e30951 into master Aug 25, 2023
@seanbudd seanbudd deleted the removeOutDateIssueTemplate branch August 25, 2023 01:39
@nvaccessAuto nvaccessAuto added this to the 2023.3 milestone Aug 25, 2023
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.

4 participants