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

Issue templates: add extra checkbox + config file #518

Merged
merged 2 commits into from
Jun 5, 2024

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented May 28, 2024

Description

Issue templates: add extra checkbox

The issue tracker is for bug reports, feature requests and structural improvement proposals only. Not for support requests.

As per the contributing guide, those belong on StackOverflow or in the discussion forum, not in the issue tracker.

Let's see if this helps to reduce the noise of people posting support requests as "bugs".

Issue templates: add configuration file

This configuration file:

  • Continues to allow blank issues to be opened.
  • Adds an extra item to the issue template chooser pointing people with support questions to Discussions.

Ref: 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

Suggested changelog entry

N/A

@rodrigoprimo
Copy link
Contributor

Nice, I think this should help reduce the number of support requests that are submitted as bugs.

As an alternative approach, have you considered adding this information to the issue template chooser instead of adding it to the new feature and bug templates? I don't have a strong opinion, but I'm inclined to think that adding this to the issue template chooser might be more effective as the information will be more visible.

@jrfnl
Copy link
Member Author

jrfnl commented Jun 2, 2024

As an alternative approach, have you considered adding this information to the issue template chooser instead of adding it to the new feature and bug templates? I don't have a strong opinion, but I'm inclined to think that adding this to the issue template chooser might be more effective as the information will be more visible.

I did consider it, but as I was out of the office, I limited the current PR to the checkbox.

I think a combination of both would probably be good, but I find the documentation on the template chooser config a little limited (and have left feedback about this).
It is unclear to me how the template chooser config would interact with something like the predefined templates and the private security reporting. Do those need to be added to the config manually or will those be added automatically ?

I suppose I could experiment with the feature to figure out the answer, but I don't want to do that experiment in this repo as it would need to be done on the master branch.

@jrfnl jrfnl changed the title Issue templates: add extra checkbox Issue templates: add extra checkbox + config file Jun 2, 2024
@jrfnl
Copy link
Member Author

jrfnl commented Jun 2, 2024

In the mean time, I've run some experiments elsewhere and have added a config file based on my findings.

@rodrigoprimo rodrigoprimo self-requested a review June 3, 2024 19:04
Copy link
Contributor

@rodrigoprimo rodrigoprimo left a comment

Choose a reason for hiding this comment

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

I tested this on my fork, and it looks good to me! Thanks, @jrfnl.

I left a comment suggesting different options for the URL used in the "Community Support" button for your consideration, but I don't see it as a blocker.

.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
@jrfnl jrfnl force-pushed the feature/update-issue-templates branch from df70002 to 18f1150 Compare June 5, 2024 08:01
jrfnl added 2 commits June 5, 2024 12:12
The issue tracker is for bug reports, feature requests and structural improvement proposals only. Not for support requests.

As per the contributing guide those belong on StackOverflow or in the discussion forum, not in the issue tracker.

Let's see if this helps to reduce the noise of people posting support requests as "bugs"
This configuration file:
* Continues to allow blank issues to be opened.
* Adds an extra item to the issue template chooser pointing people with support questions to Discussions.

Ref: 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
@jrfnl jrfnl force-pushed the feature/update-issue-templates branch from 18f1150 to a7b6134 Compare June 5, 2024 10:13
@jrfnl
Copy link
Member Author

jrfnl commented Jun 5, 2024

Rebased without further changes to get rid of the ❌

@jrfnl jrfnl merged commit ab3bb0e into master Jun 5, 2024
48 checks passed
@jrfnl jrfnl deleted the feature/update-issue-templates branch June 5, 2024 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants