docs: update README.md and CONTRIBUTING.md
#8974
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gharlan
commented
Aug 24, 2025
| @@ -27,7 +27,7 @@ projects. This tool does not only detect them, but also fixes them for you. | |||
| * PHP 8.3 | |||
| * PHP 8.4 | |||
|
|
|||
| > **Note** | |||
| > [!NOTE] | |||
There was a problem hiding this comment.
Left is old style, right is new style:
| @@ -40,7 +40,7 @@ projects. This tool does not only detect them, but also fixes them for you. | |||
|
|
|||
| The recommended way to install PHP CS Fixer is to use [Composer](https://getcomposer.org/download/): | |||
|
|
|||
| ```console | |||
| ```sh | |||
There was a problem hiding this comment.
Left is old style, right is new style:
keradus
reviewed
Sep 1, 2025
| or other community driven ones like the Symfony one. | ||
| You can **also** define your (team's) style through configuration. | ||
|
|
||
| It can modernize your code (like converting the ``pow`` function to the ``**`` operator on PHP 5.6) | ||
| It can modernize your code (like converting the `pow` function to the `**` operator on PHP 5.6) |
There was a problem hiding this comment.
why the change? i don't see any diff in UI
There was a problem hiding this comment.
common markdown syntax for inline code is single backtick. Double backticks are only necessary when using a single backtick inside the code string.
I guess it is copy paste from https://github.com/PHP-CS-Fixer/PHP-CS-Fixer.github.io/blob/generator/index.rst?plain=1#L9, but there it is rst, not md.
keradus
reviewed
Sep 1, 2025
| @@ -54,7 +54,7 @@ For more details and other installation methods (also with Docker or behind CI), | |||
| Assuming you installed PHP CS Fixer as instructed above, you can run the | |||
| following command to fix the PHP files in the `src` directory: | |||
|
|
|||
| ```console | |||
| ```sh | |||
There was a problem hiding this comment.
please apply same for CONTRIBUTING.md
keradus
approved these changes
Sep 1, 2025
README.mdREADME.md and CONTRIBUTING.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.