Skip to content

Commit a76a78e

Browse files
authored
Merge pull request #41 from PHPCSStandards/feature/iterate-on-issue-templates
Issue/PR templates: add feature request template + minor other tweaks
2 parents a97cfb4 + ea0d287 commit a76a78e

File tree

3 files changed

+34
-7
lines changed

3 files changed

+34
-7
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ echo "A short code snippet that can be used to reproduce the bug. Do NOT paste s
3030
```xml
3131
<?xml version="1.0"?>
3232
<ruleset name="My Custom Standard">
33-
<description>If you are using a custom ruleset, please enter it here.</description>
33+
<description>If you are using a custom ruleset, please enter the relevant part here.</description>
3434
</ruleset>
3535
```
3636

@@ -51,8 +51,8 @@ A clear and concise description of what you expected to happen.
5151
| | |
5252
|-|-|
5353
| 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]
54+
| PHP version | [e.g., 7.2, 8.1]
55+
| PHP_CodeSniffer version | [e.g., 3.7.2, master]
5656
| Standard | [e.g., PSR2, PSR12, Squiz, custom]
5757
| Install type | [e.g. Composer (global/local), PHAR, git clone, other (please expand)]
5858

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

.github/pull_request_template.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
labels: ['Status: triage']
3+
---
4+
15
<!-- Provide a general summary of your changes in the title above. -->
26

37
<!--
@@ -11,11 +15,11 @@ Describe your changes in detail and, if relevant, explain which choices you have
1115
-->
1216

1317

14-
### Suggested changelog entry
18+
## Suggested changelog entry
1519
<!-- Please provide a short description of the change for the changelog. -->
1620

1721

18-
### Related issues/external references
22+
## Related issues/external references
1923

2024
Fixes #
2125

@@ -37,15 +41,14 @@ Fixes #
3741
- [ ] I have added tests to cover my changes.
3842
- [ ] I have verified that the code complies with the projects coding standards.
3943
- [ ] [Required for new sniffs] I have added XML documentation for the sniff.
40-
- [ ] [Required for new files] I have added any new files to the `package.xml` file.
4144

4245
<!--
4346
============================================================================================
4447
Please make sure your pull request passes all continuous integration checks!
4548
4649
PRs which are failing their CI checks will likely be ignored by the maintainers.
4750
48-
PRs using atomic, descriptive commits are hugely appreciated as it will make
51+
Small PRs using atomic, descriptive commits are hugely appreciated as it will make
4952
reviewing your changes easier for the maintainers.
5053
============================================================================================
5154
-->

0 commit comments

Comments
 (0)