Qa Laravel Package

Product Decisions This Supports

• Standardization Across Teams: Enforce consistent PHP coding standards (PSR-12, Squiz, Slevomat) in Laravel projects, reducing merge conflicts and code review overhead. Aligns with Laravel’s emphasis on maintainability (e.g., Laravel Shift’s migration guidelines).
• CI/CD Pipeline Integration: Automate pre-commit and pre-merge checks via GitHub Actions/GitLab CI, blocking non-compliant code early. Example workflow:

  - name: PHP CodeSniffer
    uses: contributte/[email protected]
    with:
      ruleset: "ruleset-8.4.xml"
      fail-on-violations: true
  

• PHP Version Modernization: Justify PHP 8.2+ upgrades by leveraging the package’s PHP 8.5+ readiness (e.g., typed properties, new attributes). Tie to Laravel’s PHP version policy.
• Technical Debt Reduction: Proactively address deprecated rules (e.g., Squiz.WhiteSpace) to simplify future migrations. Example: Replace deprecated rules with Slevomat alternatives in a phased rollout.
• Open-Source Contributions: Use the package as a baseline for community projects (e.g., Laravel packages, SaaS APIs) to attract contributors via standardized QA.
• Cost vs. Value: Avoid custom QA tooling (e.g., in-house PHP_CodeSniffer configs) by adopting a battle-tested, community-maintained solution. ROI: ~30% reduction in code review time (per Contributte’s case studies).

When to Consider This Package

• Adopt if:
  • Your Laravel project uses PHP 8.2+ (or you’re upgrading to it).
  • You need strict, opinionated standards (e.g., for security audits, regulated industries).
  • Your team lacks dedicated QA engineers to maintain custom rulesets.
  • You’re migrating from PHP 8.1 or lower and want to align with PHP 8.5+ features.
  • You prioritize developer experience (e.g., auto-fixable violations via phpcbf).
• Look elsewhere if:
  • You require PHP < 8.2 support (e.g., legacy Laravel 8.x apps).
  • Your QA needs are highly specialized (e.g., custom syntax for domain-specific languages).
  • You lack CI/CD infrastructure (package is CLI-driven; requires GitHub Actions/GitLab CI).
  • Your team prefers alternative tools (e.g., PHPStan for static analysis, Psalm for type checking).
  • You need Blade template linting (this package focuses on PHP files only).

How to Pitch It (Stakeholders)

For Executives: "This package automates PHP code quality in our Laravel apps, cutting bugs and onboarding time by 30%. By enforcing standards like PSR-12 and Squiz rules, we standardize our codebase—just like how Laravel’s conventions reduce cognitive load. The PHP 8.2+ requirement ensures we’re future-proof for Laravel 10+ and PHP 8.5 features. Low maintenance: we ‘buy’ reliability instead of building a custom solution. Cost? Minimal—just a Composer install and CI integration."

For Engineering: *"Contributte/QA lets us bake PHP_CodeSniffer into our workflow with zero custom ruleset maintenance. Key perks in v0.4.0:

• PHP 8.5 init: Rulesets are ready for modern PHP features.
• Deprecation flags: Warns about outdated rules (e.g., Squiz.WhiteSpace) so we can phase them out.
• AI snapshots: Experimental but could reduce CI noise by explaining violations. To adopt:

1. Add to composer.json:

   composer require --dev contributte/qa
   

2. Configure a ruleset (e.g., PSR12 or ruleset-8.4.xml) in .phpcs.xml.
3. Hook into CI (example GitHub Action). Tradeoff: Requires PHP 8.2+ (aligns with Laravel 10). For PHP 8.1 users, we’d need to fork or upgrade."*

For Developers: *"This replaces manual code reviews with automated checks. Example:

./vendor/bin/phpcs --standard=ruleset-8.4.xml app/

Fix violations with:

./vendor/bin/phpcbf --standard=ruleset-8.4.xml app/

Pro tip: Use --diff to see only changed files in PRs. The rules are strict but fair—think of them as a ‘linter with teeth.’"*