Coding Standard Laravel Package

Product Decisions This Supports

• Enforcing Consistency in PHP/Laravel Codebases: Standardize coding practices across teams to reduce technical debt, improve maintainability, and accelerate onboarding.
• Adoption of Modern PHP Practices: Align with newer PHP features (e.g., property hooks) while phasing out legacy support (e.g., PHP 7.4).
• Build vs. Buy Decision: Avoid reinventing a custom PHPCS configuration; leverage a pre-built, battle-tested standard tailored for Laravel/Tideways ecosystems.
• Developer Experience (DX) Initiatives: Reduce friction in code reviews by automating style/quality checks (e.g., via CI/CD pipelines).
• Scaling Engineering Teams: Ensure uniformity as teams grow, especially in open-source or multi-repo Laravel projects.
• Compliance with Internal Standards: Enforce Tideways/Gyro-specific conventions (e.g., property syntax) without manual enforcement.

When to Consider This Package

• Adopt if:

  • Your team uses Laravel/PHP and lacks a standardized coding style.
  • You prioritize consistency over flexibility in code reviews (e.g., strict PHPCS rules).
  • Your stack aligns with PHP 8.0+ (no PHP 7.4 dependencies).
  • You’re part of the Tideways/Gyro ecosystem or want to mirror their conventions.
  • You need a lightweight, MIT-licensed solution (no vendor lock-in).

• Look elsewhere if:

  • Your team requires highly customizable PHPCS rules (e.g., PSR-12 vs. custom standards).
  • You’re using PHP 7.4 or below (unsupported in CI).
  • You need deep IDE integration (e.g., PHPStorm inspections) beyond PHPCS.
  • Your project has unique domain-specific coding needs (e.g., security-focused rules).
  • You prefer alternative tools like Pest, PHPStan, or custom Laravel policies for broader quality checks.

How to Pitch It (Stakeholders)

For Executives:

"This package lets us enforce a single, high-quality coding standard across all PHP/Laravel projects—reducing bugs, speeding up reviews, and cutting onboarding time. It’s a lightweight, MIT-licensed solution that aligns with industry leaders like Tideways, ensuring our codebase stays modern and maintainable. Think of it as ‘autopilot for code quality’—saving dev time while improving consistency."

For Engineering/Dev Teams:

"Gyro’s PHPCS standard gives us a pre-configured, Laravel-friendly set of rules to catch style issues early (e.g., property syntax, naming conventions). It’s forked from Doctrine’s standard but updated for PHP 8+ and Tideways’ needs. We can plug it into our CI pipeline (e.g., GitHub Actions) to block bad PRs before merge, cutting review cycles. Plus, it’s actively maintained—unlike rolling our own rules."

For Technical Leads:

• Pros:
  • Zero maintenance overhead: No need to curate PHPCS rules manually.
  • CI/CD ready: Integrates seamlessly with Laravel’s ecosystem (e.g., phpcs in phpunit.xml).
  • Future-proof: Drops PHP 7.4 support, future-aligns with modern PHP.
• Cons:
  • Rigid: Not ideal if your team needs to deviate from Tideways/Gyro’s conventions.
  • PHPCS-only: Won’t replace static analysis tools like PHPStan for deeper logic checks.
• Action Item: "Let’s trial this in [Project X]’s PR workflow and measure the impact on review time and defect rates."