docs: update README #271
docs: update README #271
Conversation
WalkthroughThe Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Outside diff range and nitpick comments (2)
README.md (2)
Line range hint
120-139: Review the Makefile configuration for potential improvements in clarity and efficiency.+ # This section defines the Makefile targets for linting PHP files using php-cs-fixer. + # It ensures that the necessary directories are created and that linting scripts are executed correctly.
Line range hint
147-236: Evaluate the GitHub Actions workflow for best practices and optimal configuration.Consider optimizing the matrix strategy to include different PHP versions and dependency sets to ensure broader compatibility testing.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (11 hunks)
Additional Context Used
LanguageTool (1)
README.md (1)
Near line 294: This phrasing can be overused. Try elevating your writing with a more formal alternative.
Context: ...are open to all kinds of contributions. If you want to: * 🤔 [Suggest a feature](https://gith...
Additional comments not posted (3)
README.md (3)
30-30: Ensure the introduction clearly defines the scope and purpose of the repository.
111-111: Ensure the.buildfolder is correctly ignored in the project's.gitignorefile.Verification successful
The
.buildfolder is correctly listed in the project's.gitignorefile.
.gitignorecontains the entry/.build/.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the .build folder is listed in the .gitignore file. # Test: Search for the .build entry in the .gitignore file. Expect: Presence of the entry. rg --type ignore $'/.build/'Length of output: 58
Script:
#!/bin/bash # Description: Verify the .build folder is listed in the .gitignore file. # Test: Search for the .build entry in the .gitignore file. Expect: Presence of the entry. rg '/.build/' .gitignoreLength of output: 33
98-98: Confirm that the new composer script commands are correctly implemented and function as intended.
| * Create PHP file and name it `.php-cs-fixer.dist.php` and place it inside root directory of project. It will be recognized by PHP CS Fixer automatically. | ||
|
|
||
| - Example contents of `.php-cs-fixer.dist.php` file: | ||
| * Example contents of `.php-cs-fixer.dist.php` file: |
There was a problem hiding this comment.
Clarify the setup instructions for .php-cs-fixer.dist.php to ensure they are easy to follow for new users.
- * Create PHP file and name it `.php-cs-fixer.dist.php` and place it inside root directory of project. It will be recognized by PHP CS Fixer automatically.
+ * Create a PHP file named `.php-cs-fixer.dist.php` and place it in the root directory of your project. PHP CS Fixer will automatically recognize this configuration file.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * Create PHP file and name it `.php-cs-fixer.dist.php` and place it inside root directory of project. It will be recognized by PHP CS Fixer automatically. | |
| - Example contents of `.php-cs-fixer.dist.php` file: | |
| * Example contents of `.php-cs-fixer.dist.php` file: | |
| * Create a PHP file named `.php-cs-fixer.dist.php` and place it in the root directory of your project. PHP CS Fixer will automatically recognize this configuration file. | |
| * Example contents of `.php-cs-fixer.dist.php` file: |
| Thank you for considering contributing to the wayofdev community! We are open to all kinds of contributions. If you want to: | ||
|
|
||
| - 🤔 [Suggest a feature](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+enhancement&projects=&template=2-feature-request.yml&title=%5BFeature%5D%3A+) | ||
| - 🐛 [Report an issue](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=1-bug-report.yml&title=%5BBug%5D%3A+) | ||
| - 📖 [Improve documentation](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=4-docs-bug-report.yml&title=%5BDocs%5D%3A+) | ||
| - 👨💻 Contribute to the code | ||
| * 🤔 [Suggest a feature](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+enhancement&projects=&template=2-feature-request.yml&title=%5BFeature%5D%3A+) | ||
| * 🐛 [Report an issue](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=1-bug-report.yml&title=%5BBug%5D%3A+) | ||
| * 📖 [Improve documentation](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=4-docs-bug-report.yml&title=%5BDocs%5D%3A+) | ||
| * 👨💻 Contribute to the code |
There was a problem hiding this comment.
Elevate the formal tone of the contribution invitation.
- Thank you for considering contributing to the wayofdev community! We are open to all kinds of contributions. If you want to:
+ Thank you for considering a contribution to the wayofdev community! We welcome diverse contributions. Should you wish to:Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| Thank you for considering contributing to the wayofdev community! We are open to all kinds of contributions. If you want to: | |
| - 🤔 [Suggest a feature](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+enhancement&projects=&template=2-feature-request.yml&title=%5BFeature%5D%3A+) | |
| - 🐛 [Report an issue](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=1-bug-report.yml&title=%5BBug%5D%3A+) | |
| - 📖 [Improve documentation](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=4-docs-bug-report.yml&title=%5BDocs%5D%3A+) | |
| - 👨💻 Contribute to the code | |
| * 🤔 [Suggest a feature](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+enhancement&projects=&template=2-feature-request.yml&title=%5BFeature%5D%3A+) | |
| * 🐛 [Report an issue](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=1-bug-report.yml&title=%5BBug%5D%3A+) | |
| * 📖 [Improve documentation](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=4-docs-bug-report.yml&title=%5BDocs%5D%3A+) | |
| * 👨💻 Contribute to the code | |
| Thank you for considering a contribution to the wayofdev community! We welcome diverse contributions. Should you wish to: | |
| * 🤔 [Suggest a feature](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+enhancement&projects=&template=2-feature-request.yml&title=%5BFeature%5D%3A+) | |
| * 🐛 [Report an issue](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=1-bug-report.yml&title=%5BBug%5D%3A+) | |
| * 📖 [Improve documentation](https://github.com/wayofdev/php-cs-fixer-config/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=4-docs-bug-report.yml&title=%5BDocs%5D%3A+) | |
| * 👨💻 Contribute to the code |
| ## 📜 Custom Rulesets | ||
|
|
||
| **```WayOfDev\PhpCsFixer\Config\RuleSets\DefaultRuleset::class```** | ||
|
|
||
| Based on **`@Symfony`** ruleset | ||
|
|
||
| * Used by [`@wayofdev`](https://github.com/wayofdev) organization | ||
|
|
||
| **`WayOfDev\PhpCsFixer\Config\RuleSets\ExtendedPERSet::class`** | ||
|
|
||
| Based on **`@PER-CS2.0`** ruleset | ||
|
|
||
| * Used by [`@buggregator`](https://github.com/buggregator) and [`@cycle`](http://github.com/cycle) organizations | ||
|
|
There was a problem hiding this comment.
Tip
Codebase Verification
The DefaultRuleset class was not found in the codebase, while the ExtendedPERSet class was located and its implementation details were partially retrieved.
DefaultRulesetclass not found.ExtendedPERSetclass found insrc/RuleSets/ExtendedPERSet.php.
Please verify the existence and correct implementation of the DefaultRuleset class or update the README.md accordingly.
Analysis chain
Verify the accuracy of the new custom rulesets and their descriptions.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the existence and correct implementation of the new custom rulesets.
# Test: Search for the ruleset classes in the codebase. Expect: Definitions of the classes.
rg --type php $'class DefaultRuleset' && rg --type php $'class ExtendedPERSet'
Length of output: 38
Script:
#!/bin/bash
# Description: Verify the existence and correct implementation of the new custom rulesets.
# Test: Search for the ruleset classes in the codebase. Expect: Definitions of the classes.
rg --type php 'class DefaultRuleset' || echo "DefaultRuleset class not found"
rg --type php 'class ExtendedPERSet' || echo "ExtendedPERSet class not found"
# If classes are found, display their file paths and a few lines of context around their definitions.
rg --type php 'class DefaultRuleset' -A 5 -B 5
rg --type php 'class ExtendedPERSet' -A 5 -B 5
Length of output: 1007
| * **Twitter:** Follow our organization [@wayofdev](https://twitter.com/intent/follow?screen_name=wayofdev) and the author [@wlotyp](https://twitter.com/intent/follow?screen_name=wlotyp). | ||
| * **Discord:** Join our community on [Discord](https://discord.gg/CE3TcCC5vr). | ||
|
|
||
| <p align="left"> | ||
| <a href="https://discord.gg/CE3TcCC5vr" target="_blank"><img alt="Codecov" src="https://img.shields.io/discord/1228506758562058391?style=for-the-badge&logo=discord&labelColor=7289d9&logoColor=white&color=39456d"></a> | ||
| <a href="https://x.com/intent/follow?screen_name=wayofdev" target="_blank"><img alt="Follow on Twitter (X)" src="https://img.shields.io/badge/-Follow-black?style=for-the-badge&logo=X"></a> | ||
| <a href="https://discord.gg/CE3TcCC5vr" target="_blank"><img alt="Codecov" src="https://img.shields.io/discord/1228506758562058391?style=for-the-badge&logo=discord&labelColor=7289d9&logoColor=white&color=39456d"></a> | ||
| <a href="https://x.com/intent/follow?screen_name=wayofdev" target="_blank"><img alt="Follow on Twitter (X)" src="https://img.shields.io/badge/-Follow-black?style=for-the-badge&logo=X"></a> |
There was a problem hiding this comment.
Tip
Codebase Verification
The Twitter link returned a 403 Forbidden status, which suggests there might be an issue with the link or access restrictions. The Discord link, however, redirected correctly to a valid invite link.
- The Twitter link needs to be reviewed and potentially corrected.
- The Discord link is functioning as expected.
Analysis chain
Confirm the accuracy and functionality of the social links and ensure they lead to the correct pages.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the functionality of social links.
# Test: Check if the URLs are reachable and correct.
curl -I https://twitter.com/intent/follow?screen_name=wayofdev && curl -I https://discord.gg/CE3TcCC5vr
Length of output: 2103
Summary by CodeRabbit
Documentation
New Features