Merge pull request #449 from PHPCSStandards/feature/clean-up-markdown-files

Docs: clean up markdown files

Author: jrfnl

.github/CONTRIBUTING.md

@@ -1,25 +1,24 @@
-Contributing
--------------
+# Contributing
 
 Thank you for your interest in contributing to PHP_CodeSniffer!
 
 
 ## Table of Contents
 
 * [Reporting Bugs](#reporting-bugs)
-   - [Reporting Security Issues](#reporting-security-issues)
-   - [Support/Questions About Using PHP_CodeSniffer](#supportquestions-about-using-php_codesniffer)
+    * [Reporting Security Issues](#reporting-security-issues)
+    * [Support/Questions About Using PHP_CodeSniffer](#supportquestions-about-using-php_codesniffer)
 * [Contributing Without Writing Code](#contributing-without-writing-code)
-   - [Bug Triage](#bug-triage)
-   - [Testing Open Pull Requests](#testing-open-pull-requests)
-   - [Writing sniff documentation](#writing-sniff-documentation)
-   - [Other tasks](#other-tasks)
+    * [Bug Triage](#bug-triage)
+    * [Testing Open Pull Requests](#testing-open-pull-requests)
+    * [Writing sniff documentation](#writing-sniff-documentation)
+    * [Other tasks](#other-tasks)
 * [Contributing With Code](#contributing-with-code)
-   - [Requesting/Submitting New Features](#requestingsubmitting-new-features)
-   - [Getting started](#getting-started)
-   - [While working on a patch](#while-working-on-a-patch)
-   - [Writing tests](#writing-tests)
-   - [Submitting your pull request](#submitting-your-pull-request)
+    * [Requesting/Submitting New Features](#requestingsubmitting-new-features)
+    * [Getting started](#getting-started)
+    * [While working on a patch](#while-working-on-a-patch)
+    * [Writing tests](#writing-tests)
+    * [Submitting your pull request](#submitting-your-pull-request)
 * [Licensing](#licensing)
 
 
@@ -71,7 +70,7 @@ This includes checking whether the bug is something which should be fixed in **_
 To find bugs which need triage, look for issues and PRs with the
 ["Status: triage"](https://github.com/PHPCSStandards/PHP_CodeSniffer/labels/Status%3A%20triage) label.
 
-#### Typical bug triage tasks:
+#### Typical bug triage tasks
 * Verify whether the bug is reproducible with the given information.
 * Ask for additional information if it is not.
 * 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
     The PHAR files can be found on the summary page of the test workflow run for the PR.
     If the workflow has not been run (yet), the PHAR artifact may not be available (yet).
 
-#### Typical test tasks:
+#### Typical test tasks
 * Verify that the patch solves the originally reported problem.
 * Verify that the tests added in the PR fail without the fix and pass with the fix.
 * For a fix for false negatives: verify that the correct error message(s) are thrown by the patched code.
@@ -168,10 +167,11 @@ This is an open invitation for interested parties to gather their thoughts about
 > Kind request: If you don't have something to add to the discussion, but do want to indicate a positive or negative opinion
 > on a topic, please add an emoji on the original post instead of leaving a comment.
 
-> :bulb: On a subset of these issues - the ones which impact maintainers or integrators -, a list of known interested parties
-> will be pinged (cc-ed) to gather their thoughts on the topic.
->
-> This list is public and
+On a subset of these issues - the ones which impact maintainers or integrators -, a list of known interested parties
+will be pinged (cc-ed) to gather their thoughts on the topic.
+
+> [!TIP]
+> This cc-list list is public and
 > [maintained in a markdown file](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/.github/community-cc-list.md).
 >
 > To add or remove yourself to/from this list, submit a PR to the repo updating the `community-cc-list.md` file.
@@ -256,9 +256,9 @@ For example, for the sniff named `Generic.NamingConventions.ConstructorName`:
 * The sniff lives in the `src/Standards/Generic/Sniffs/NamingConventions/` directory.
 * The tests live in the `src/Standards/Generic/Tests/NamingConventions/` directory.
 * The tests consist of two files:
-    - `src/Standards/Generic/Tests/NamingConventions/ConstructorNameUnitTest.inc` which is the test _case_ file containing
+    * `src/Standards/Generic/Tests/NamingConventions/ConstructorNameUnitTest.inc` which is the test _case_ file containing
        code for the sniff to analyse.
-    - `src/Standards/Generic/Tests/NamingConventions/ConstructorNameUnitTest.php` which is the test file, containing two methods,
+    * `src/Standards/Generic/Tests/NamingConventions/ConstructorNameUnitTest.php` which is the test file, containing two methods,
         `getErrorList()` and `getWarningList()`, which should each return an array with as the keys the line number
         in the test _case_ file and as the values the number of errors or warnings which are expected on each line.
         Only lines on which errors/warnings are expected need to be included in the lists. All other lines will automatically
@@ -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:

.github/ISSUE_TEMPLATE/bug_report.md

@@ -19,11 +19,13 @@ standard repository (not here).
 -->
 
 ## Describe the bug
+
 A clear and concise description of what the bug is.
 
 ### Code sample
 ```php
-echo "A short code snippet that can be used to reproduce the bug. Do NOT paste screenshots of code!";
+echo 'A short code snippet that can be used to reproduce the bug.';
+echo 'Do NOT paste screenshots of code!";
 ```
 
 ### Custom ruleset
@@ -39,27 +41,29 @@ Steps to reproduce the behavior:
 1. Create a file called `test.php` with the code sample above...
 2. Run `phpcs test.php ...`
 3. See error message displayed
-```
+```text
 PHPCS output here
 ```
 
 ## Expected behavior
+
 A clear and concise description of what you expected to happen.
 
 ## Versions (please complete the following information)
 
-| | |
-|-|-|
-| Operating System | [e.g., Windows 10, MacOS 10.15]
-| 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)]
+|                                       |                                                                                                           |
+|--------------------------|----------------------------------------------------------------------  |
+| Operating System           | [e.g., Windows 10, MacOS 10.15]                                                       |
+| 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)] |
 
 ## Additional context
+
 Add any other context about the problem here.
 
-## Please confirm:
+## Please confirm
 
 - [ ] I have searched the issue list and am not opening a duplicate issue.
 - [ ] I confirm that this bug is a bug in PHP_CodeSniffer and not in one of the external standards.

.github/community-cc-list.md

@@ -1,6 +1,6 @@
-<!--
-PHP_CodeSniffer Community CC List
+# PHP_CodeSniffer Community CC List
 
+<!--
 This list will be used on select tickets to ping the wider PHP_CodeSniffer community for input.
 
 If you want to be on this list, feel free to submit a PR to add yourself.

.github/pull_request_template.md

@@ -4,7 +4,7 @@
 Please target the `master` branch when submitting your pull request, unless your change **only** applies to PHPCS 4.x.
 -->
 
-## Description
+# Description
 <!--
 What do you want to achieve with this PR? Why did you write this code? What problem does this PR solve?
 Describe your changes in detail and, if relevant, explain which choices you have made and why.
@@ -39,7 +39,7 @@ Fixes #
 - [ ] 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).
 - [ ] 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 sniffs\] I have added XML documentation for the sniff.
 
 <!--
 ============================================================================================