Skip to content

Commit de2e39a

Browse files
jrfnljrfnl
committed
WIP | Add issue and PR templates
1 parent a4211ec commit de2e39a

File tree

3 files changed

+132
-0
lines changed

3 files changed

+132
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
name: "\U0001F41B Bug report for sniffs"
3+
about: I got unexpected behavior and think it is a bug.
4+
title: ''
5+
6+
---
7+
8+
<!--
9+
PLEASE FILL OUT THE TEMPLATE COMPLETELY.
10+
BUG REPORTS WHICH CANNOT BE REPRODUCED BASED ON THE INFORMATION PROVIDED WILL BE CLOSED.
11+
-->
12+
13+
## Bug Description
14+
<!-- Provide a clear and concise description of the problem you are experiencing. -->
15+
16+
17+
## Given the following reproduction Scenario
18+
<!-- Please provide example code that allows us to reproduce the issue. Do NOT paste screenshots of code! -->
19+
20+
The issue happens when running this command:
21+
<!-- Adjust the below command as appropriate. -->
22+
```bash
23+
phpcs -ps file.php --standard=...
24+
```
25+
26+
... over a file containing this code:
27+
```php
28+
// Place your code sample here.
29+
```
30+
31+
<!-- Optionally post a *minimal* version of your custom ruleset here if needed to reproduce the issue. -->
32+
... with this custom ruleset:
33+
```xml
34+
<?xml version="1.0"?>
35+
<ruleset name="My Custom Standard">
36+
...
37+
</ruleset>
38+
```
39+
40+
41+
### I'd expect the following behaviour
42+
<!-- What was the expected (correct) behavior? -->
43+
44+
45+
### Instead this happened
46+
<!--
47+
What is the current (buggy) behavior?
48+
Please provide as much information as possible and relevant.
49+
50+
Whenever possible, include the error message and the error code for the sniff that is being
51+
(or should have been) triggered.
52+
You can see the sniff error codes by running `phpcs` with the `-s` flag.
53+
Example: `Universal.Arrays.DuplicateArrayKey.Found`
54+
-->
55+
56+
57+
## Environment
58+
<!--
59+
Please include as many details as relevant about the environment you experienced the bug in.
60+
You should be able to get the version numbers using the `composer info` command.
61+
-->
62+
63+
| Environment | Answer |
64+
| ----------------------- | ------------------------------------------------------------------------------ |
65+
| PHP version | x.y.z |
66+
| PHP_CodeSniffer version | x.y.z |
67+
| PHPCSExtra version | x.y.z |
68+
| PHPCSUtils version | x.y.z |
69+
| Install type | e.g. Composer global, Composer project local, git clone, other (please expand) |
70+
71+
72+
## Additional Context (optional)
73+
<!-- Add any other context about the problem here. -->
74+
75+
76+
## Tested Against `develop` branch?
77+
78+
- [ ] I have verified the issue still exists in the `develop` branch of PHPCSExtra.

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: "\U0001F680 Feature request"
3+
about: I have a suggestion (and may want to implement it).
4+
title: ''
5+
6+
---
7+
8+
## Is your feature request related to a problem?
9+
<!-- Please provide a clear and concise description of what the feature is which you'd like to see implemented. -->
10+
11+
## Describe the solution you'd like
12+
<!--
13+
A clear and concise description of what you want to happen.
14+
15+
Please include some code samples of what should be flagged and preferably also some
16+
code samples of what should *not* be flagged.
17+
-->
18+
19+
## Additional context (optional)
20+
<!-- Add any other context or screenshots about the feature request here. -->
21+
22+
- [ ] I intend to create a pull request to implement this feature.

‎.github/pull_request_template.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!-- Provide a general summary of your changes in the title above. -->
2+
3+
# Description
4+
<!--
5+
What do you want to achieve with this PR? What problem does this PR solve?
6+
Describe your changes in detail and, if relevant, explain which choices you have made and why.
7+
-->
8+
9+
10+
## Related issues/external references
11+
12+
Fixes #
13+
14+
15+
## PR checklist
16+
<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
17+
- [ ] I have checked there is no other PR open for the same change.
18+
- [ ] I have read the [Contribution Guidelines](https://github.com/PHPCSStandards/PHP_CodeSniffer-documentation/blob/main/CONTRIBUTING.md).
19+
- [ ] I grant the project the right to include my changes under the BSD-3-Clause license (and I have the right to grant these rights).
20+
- [ ] I have verified that the code complies with the projects coding standards.
21+
- [ ] [When adding a new Wiki page] I have added the new page to the `_Sidebar.md` file.
22+
23+
<!--
24+
============================================================================================
25+
Please make sure your pull request passes all continuous integration checks!
26+
27+
PRs which are failing their CI checks will likely be ignored by the maintainers.
28+
29+
Small PRs using atomic, descriptive commits are hugely appreciated as it will make
30+
reviewing your changes easier for the maintainers.
31+
============================================================================================
32+
-->

0 commit comments

Comments
 (0)