Skip to content

Commit 37a0024

Browse files
committed
QA/Markdown CS: various tweaks
* Code snippets which either _look like markdown_ or could confuse markdown parsers, should be wrapped in backticks. * Text in square brackets, which is not a link, should escape the square brackets. * Various (tooling) names should use proper case, except when used in code snippets. To that end, either fix the case of the term or wrap the code snippet in backticks. * No blank line within lists. * No trailing spaces. Note: especially in the CHANGELOG file, there is a lot more text which should be wrapped in backticks, but that's outside the scope of this current PR, which is aimed at one the one hand preventing markdown parsing problems and on the other hand allowing to run an automated Markdownlint check via CI.
1 parent 15e1f09 commit 37a0024

File tree

3 files changed

+83
-85
lines changed

3 files changed

+83
-85
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ While not strictly required, it is greatly appreciated if you comply with the fo
339339

340340
* Prefix the commit short description with a hint as to what code is touched in the commit.
341341
Example: If you have a bug fix for the `Squiz.WhiteSpace.OperatorSpacing` sniff, it is a good idea to prefix
342-
the short description with `Squiz/OperatorSpacing: `.
342+
the short description with `Squiz/OperatorSpacing:`.
343343
Another example: if your PR addresses an issue with the Filter classes, prefix the short description
344344
with `Filters:` or `Filters/FilterName:`.
345345
Doing so will:

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Fixes #
3939
- [ ] 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).
4040
- [ ] I have added tests to cover my changes.
4141
- [ ] I have verified that the code complies with the projects coding standards.
42-
- [ ] [Required for new sniffs] I have added XML documentation for the sniff.
42+
- [ ] \[Required for new sniffs\] I have added XML documentation for the sniff.
4343

4444
<!--
4545
============================================================================================

0 commit comments

Comments
 (0)