WordPress-Coding-Standards/.github/ISSUE_TEMPLATE/bug_report.md
jrfnl 75ec4e2dff Bug report template: various improvements
After the umpteenth time of getting a non-reproducible bug report (not just in this repo, mind you), I figured it may help to add some more guidance to the bug report template.

More important changes:
* Ask for the actual CLI command people have used.
* Ask for the custom ruleset used (if used).
* Give some guidance on how to find out the version numbers of the tooling used.
2021-06-15 16:08:36 +02:00

2.2 KiB

name about
Bug report Create a report to help us improve

Bug Description

Minimal Code Snippet

The issue happens when running this command:

phpcs ...

... over a file containing this code:

// Place your code sample here.

The file was auto-fixed via phpcbf to:

// Place your code sample here.

... while I expected the code to be fixed to:

// Place your code sample here.

Error Code

Custom ruleset

<?xml version="1.0"?>
<ruleset name="My Custom Standard">
  ...
</ruleset>

Environment

Question Answer
PHP version x.y.z
PHP_CodeSniffer version x.y.z
WPCS version x.y.z
WPCS install type e.g. Composer global, Composer project local, git clone, other (please expand)
IDE (if relevant) Name and version e.g. PhpStorm 2018.2.2

Additional Context (optional)

Tested Against develop branch?

  • I have verified the issue still exists in the develop branch of WPCS.