Skip to content

Commit

Permalink
QA/Markdown CS: various tweaks
Browse files Browse the repository at this point in the history
* Code snippets which either _look like markdown_ or could confuse markdown parsers, should be wrapped in backticks.
* 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.

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.
  • Loading branch information
jrfnl committed Apr 14, 2024
1 parent e2dc56a commit a9ae9dd
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 81 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ While not strictly required, it is greatly appreciated if you comply with the fo

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

0 comments on commit a9ae9dd

Please sign in to comment.