Skip to content

Commit 7439720

Browse files
committed
QA/Markdown CS: use consistent header styles
* Always use the `atx` style headers (`# ...`). * Use consistent blank lines around headers. * No trailing punctuation in headers. * Every file should have a header. * First header in a file should be an H1. Note: the issue templates do not trigger this error as they use frontmatter with a `title` attribute. However, frontmatter is not supported for pull request templates.
1 parent dba1cc1 commit 7439720

File tree

6 files changed

+140
-10
lines changed

6 files changed

+140
-10
lines changed

.github/CONTRIBUTING.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Contributing
2-
-------------
1+
# Contributing
32

43
Thank you for your interest in contributing to PHP_CodeSniffer!
54

@@ -71,7 +70,7 @@ This includes checking whether the bug is something which should be fixed in **_
7170
To find bugs which need triage, look for issues and PRs with the
7271
["Status: triage"](https://github.com/PHPCSStandards/PHP_CodeSniffer/labels/Status%3A%20triage) label.
7372

74-
#### Typical bug triage tasks:
73+
#### Typical bug triage tasks
7574
* Verify whether the bug is reproducible with the given information.
7675
* Ask for additional information if it is not.
7776
* If you find the issue is reported to the wrong repo, ask the reporter to report it to the correct external standard repo
@@ -95,7 +94,7 @@ To get access to a PHPCS version which includes the patch from a pull request, y
9594
The PHAR files can be found on the summary page of the test workflow run for the PR.
9695
If the workflow has not been run (yet), the PHAR artifact may not be available (yet).
9796

98-
#### Typical test tasks:
97+
#### Typical test tasks
9998
* Verify that the patch solves the originally reported problem.
10099
* Verify that the tests added in the PR fail without the fix and pass with the fix.
101100
* For a fix for false negatives: verify that the correct error message(s) are thrown by the patched code.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ standard repository (not here).
1919
-->
2020

2121
## Describe the bug
22+
2223
A clear and concise description of what the bug is.
2324

2425
### Code sample
@@ -44,6 +45,7 @@ PHPCS output here
4445
```
4546

4647
## Expected behavior
48+
4749
A clear and concise description of what you expected to happen.
4850

4951
## Versions (please complete the following information)
@@ -57,9 +59,10 @@ A clear and concise description of what you expected to happen.
5759
| Install type | [e.g. Composer (global/local), PHAR, git clone, other (please expand)]
5860

5961
## Additional context
62+
6063
Add any other context about the problem here.
6164

62-
## Please confirm:
65+
## Please confirm
6366

6467
- [ ] I have searched the issue list and am not opening a duplicate issue.
6568
- [ ] I confirm that this bug is a bug in PHP_CodeSniffer and not in one of the external standards.

.github/community-cc-list.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
<!--
2-
PHP_CodeSniffer Community CC List
1+
# PHP_CodeSniffer Community CC List
32

3+
<!--
44
This list will be used on select tickets to ping the wider PHP_CodeSniffer community for input.
55
66
If you want to be on this list, feel free to submit a PR to add yourself.

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Please target the `master` branch when submitting your pull request, unless your change **only** applies to PHPCS 4.x.
55
-->
66

7-
## Description
7+
# Description
88
<!--
99
What do you want to achieve with this PR? Why did you write this code? What problem does this PR solve?
1010
Describe your changes in detail and, if relevant, explain which choices you have made and why.

0 commit comments

Comments
 (0)