Skip to content

Commit d439d98

Browse files
committed
Add a pull request template
This pull requests template has been set up to attempt to gather all information needed by the maintainers to evaluate the PR. It also is intended to act as a reminder for contributors to make sure the PR is complete and ready for review.
1 parent a26c071 commit d439d98

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

.github/pull_request_template.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!-- Provide a general summary of your changes in the title above. -->
2+
3+
<!--
4+
Please target the `master` branch when submitting your pull request, unless your change **only** applies to PHPCS 4.x.
5+
-->
6+
7+
## Description
8+
<!--
9+
What do you want to achieve with this PR? Why did you write this code? What problem does this PR solve?
10+
Describe your changes in detail and, if relevant, explain which choices you have made and why.
11+
-->
12+
13+
14+
### Suggested changelog entry
15+
<!-- Please provide a short description of the change for the changelog. -->
16+
17+
18+
### Related issues/external references
19+
20+
Fixes #
21+
22+
23+
## Types of changes
24+
<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
25+
- [ ] Bug fix _(non-breaking change which fixes an issue)_
26+
- [ ] New feature _(non-breaking change which adds functionality)_
27+
- [ ] Breaking change _(fix or feature that would cause existing functionality to change)_
28+
- [ ] This change is only breaking for integrators, not for external standards or end-users.
29+
- [ ] Documentation improvement
30+
31+
32+
## PR checklist
33+
<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
34+
- [ ] I have checked there is no other PR open for the same change.
35+
- [ ] I have read the [Contribution Guidelines](.github/CONTRIBUTING.md).
36+
- [ ] I grant the project the right to include and distribute the code under the BSD-3-Clause license (and I have the right to grant these rights).
37+
- [ ] I have added tests to cover my changes.
38+
- [ ] I have verified that the code complies with the projects coding standards.
39+
- [ ] [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.
41+
42+
<!--
43+
============================================================================================
44+
Please make sure your pull request passes all continuous integration checks!
45+
46+
PRs which are failing their CI checks will likely be ignored by the maintainers.
47+
48+
PRs using atomic, descriptive commits are hugely appreciated as it will make
49+
reviewing your changes easier for the maintainers.
50+
============================================================================================
51+
-->

0 commit comments

Comments
 (0)