Skip to content

Issue/PR templates: add feature request template + minor other tweaks #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 9, 2023
Merged

Issue/PR templates: add feature request template + minor other tweaks #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ echo "A short code snippet that can be used to reproduce the bug. Do NOT paste s
```xml
<?xml version="1.0"?>
<ruleset name="My Custom Standard">
<description>If you are using a custom ruleset, please enter it here.</description>
<description>If you are using a custom ruleset, please enter the relevant part here.</description>
</ruleset>
```

Expand All @@ -51,8 +51,8 @@ A clear and concise description of what you expected to happen.
| | |
|-|-|
| Operating System | [e.g., Windows 10, MacOS 10.15]
| PHP version | [e.g., 7.2, 7.4]
| PHP_CodeSniffer version | [e.g., 3.5.5, master]
| PHP version | [e.g., 7.2, 8.1]
| PHP_CodeSniffer version | [e.g., 3.7.2, master]
| Standard | [e.g., PSR2, PSR12, Squiz, custom]
| Install type | [e.g. Composer (global/local), PHAR, git clone, other (please expand)]

Expand Down
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature request
about: I have a suggestion (and may want to implement it).
title: ''
labels: ['Status: triage', 'Type: enhancement']
assignees: ''

---

## Is your feature request related to a problem?
<!-- Please provide a clear and concise description of what the feature is which you'd like to see implemented. -->

## Describe the solution you'd like
<!--
A clear and concise description of what you want to happen.

Please include some code samples of what should be flagged and preferably also some
code samples of what should *not* be flagged.
-->

## Additional context (optional)
<!-- Add any other context or screenshots about the feature request here. -->

- [ ] I intend to create a pull request to implement this feature.
11 changes: 7 additions & 4 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
labels: ['Status: triage']
---

<!-- Provide a general summary of your changes in the title above. -->

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


### Suggested changelog entry
## Suggested changelog entry
<!-- Please provide a short description of the change for the changelog. -->


### Related issues/external references
## Related issues/external references

Fixes #

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

<!--
============================================================================================
Please make sure your pull request passes all continuous integration checks!

PRs which are failing their CI checks will likely be ignored by the maintainers.

PRs using atomic, descriptive commits are hugely appreciated as it will make
Small PRs using atomic, descriptive commits are hugely appreciated as it will make
reviewing your changes easier for the maintainers.
============================================================================================
-->