Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update codestyle.md #337

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

LadySolveig
Copy link
Contributor

@LadySolveig LadySolveig commented Nov 21, 2024

User description

Adds documentation for the command shortcuts for codestyle checks - joomla/joomla-cms#44498


PR Type

Documentation


Description

  • Added documentation for shortcut script commands to facilitate code style checks using composer.
  • Included example commands for running phpcs and csfixer via composer.
  • Provided full command references for both code style checking and fixing processes.

Changes walkthrough 📝

Relevant files
Documentation
codestyle.md
Add shortcut commands for code style checks in documentation

versioned_docs/version-5.2/get-started/codestyle.md

  • Added documentation for shortcut script commands for code style
    checks.
  • Included example commands for phpcs and csfixer.
  • Provided full command references for code style checking and fixing.
  • +8/-0     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Documentation Clarity
    The documentation should clarify whether these commands should be run from the project root directory and whether they require any initial setup or configuration

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @HLeithner
    Copy link
    Member

    please add this at least to /docs/....

    @HLeithner
    Copy link
    Member

    at

    ```./libraries/vendor/bin/phpcbf --extensions=php -p --standard=ruleset.xml .```
    we explain how to use phpcbf for the same thing, should be reduced to only explain one?

    @LadySolveig
    Copy link
    Contributor Author

    phpcbf is fixing.
    I only added shortcut scripts for code checks, not for fixing.

    In my opinion two different things.

    As php-cs-fixer was missing completely in the documentation I only added this option to the checker section.

    But if you prefer a breakdown per tool and not per use case, then I'll just split it.

    @LadySolveig
    Copy link
    Contributor Author

    Now I get it, should I remove php-cs-fixer?

    @HLeithner
    Copy link
    Member

    Don't know, if we need 2 then keep it, if we prefer one then not ;-)

    @LadySolveig
    Copy link
    Contributor Author

    Hopefully now the right way 😄 Thanks!

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants