search

PHPCSStandards / PHP_CodeSniffer

PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.
BSD 3-Clause "New" or "Revised" License
805 stars 47 forks source link

Issue templates: add extra checkbox + config file #518

Closed jrfnl closed 1 month ago

jrfnl commented 1 month ago

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:

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 commented 1 month ago

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 commented 1 month ago

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 commented 1 month ago

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

jrfnl commented 1 month ago

Rebased without further changes to get rid of the :x: