Skip to content

Commit 5798f29

Browse files
committed
Merge branch 'feature/bug-report-template-iterate'
2 parents 2e59060 + 70476e5 commit 5798f29

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,23 @@ Please report bugs for externally maintained sniffs to the appropriate external
1818
standard repository (not here).
1919
-->
2020

21-
**Describe the bug**
21+
## Describe the bug
2222
A clear and concise description of what the bug is.
2323

24-
**Code sample**
24+
### Code sample
2525
```php
26-
echo "A short code snippet that can be used to reproduce the bug";
26+
echo "A short code snippet that can be used to reproduce the bug. Do NOT paste screenshots of code!";
2727
```
2828

29-
**Custom ruleset**
29+
### Custom ruleset
3030
```xml
3131
<?xml version="1.0"?>
3232
<ruleset name="My Custom Standard">
3333
<description>If you are using a custom ruleset, please enter it here.</description>
3434
</ruleset>
3535
```
3636

37-
**To reproduce**
37+
### To reproduce
3838
Steps to reproduce the behavior:
3939
1. Create a file called `test.php` with the code sample above...
4040
2. Run `phpcs test.php ...`
@@ -43,14 +43,24 @@ Steps to reproduce the behavior:
4343
PHPCS output here
4444
```
4545

46-
**Expected behavior**
46+
## Expected behavior
4747
A clear and concise description of what you expected to happen.
4848

49-
**Versions (please complete the following information):**
50-
- OS: [e.g., Windows 10, MacOS 10.15]
51-
- PHP: [e.g., 7.2, 7.4]
52-
- PHPCS: [e.g., 3.5.5, master]
53-
- Standard: [e.g., PSR2, PSR12, Squiz]
49+
## Versions (please complete the following information)
5450

55-
**Additional context**
51+
| | |
52+
|-------------------------|------------------------------------------------------------------------------|
53+
| Operating System | [e.g., Windows 10, MacOS 10.15] |
54+
| PHP version | [e.g., 7.2, 7.4] |
55+
| PHP_CodeSniffer version | [e.g., 3.5.5, master] |
56+
| Standard | [e.g., PSR2, PSR12, Squiz, custom] |
57+
| Install type | [e.g. Composer (global/local), PHAR, PEAR, git clone, other (please expand)] |
58+
59+
## Additional context
5660
Add any other context about the problem here.
61+
62+
## Please confirm:
63+
64+
- [ ] I have searched the issue list and am not opening a duplicate issue.
65+
- [ ] I confirm that this bug is a bug in PHP_CodeSniffer and not in one of the external standards.
66+
- [ ] I have verified the issue still exists in the `master` branch of PHP_CodeSniffer.

0 commit comments

Comments
 (0)