Coding Standard Laravel Package

Product Decisions This Supports

• Enforcing Consistency in Codebases: Adopting this package enables the team to enforce a strict, standardized coding style across PHP/Laravel projects, reducing onboarding friction and improving readability. This aligns with initiatives to improve code quality and maintainability.
• Developer Experience (DX) Improvements: By integrating this into CI/CD pipelines (e.g., pre-commit hooks, GitHub Actions), the team can automate code reviews for style violations, freeing engineers from manual checks and reducing merge conflicts.
• Scaling Engineering Teams: As the team grows, a consistent coding standard reduces cognitive load for new hires and ensures long-term maintainability. This is critical for projects with multiple contributors or open-source contributions.
• Roadmap for Open-Source Contributions: If the company plans to contribute to or adopt open-source PHP projects (e.g., Laravel ecosystem packages), this standard ensures compatibility with Contributte, Apitte, and Nettrine, which already use it.
• Build vs. Buy Decision: Instead of building a custom linting solution, this package provides a pre-validated, battle-tested standard, reducing development overhead. The MIT license also avoids legal risks.
• Performance and Security: Strict standards (e.g., PHP 7.4+ compatibility, type declarations) indirectly improve performance and reduce security risks by enforcing modern practices.

When to Consider This Package

• Adopt When:

  • Your team is starting a new Laravel/PHP project or refactoring an existing one to enforce consistency.
  • You prioritize developer productivity and want to automate style enforcement (e.g., via CI/CD or IDE integration).
  • Your project involves multiple contributors or aims for open-source adoption, where standardized codebases are critical.
  • You’re already using PHP-CS-Fixer or PHP_CodeSniffer but need a more opinionated, strict standard out of the box.
  • Your team values modern PHP practices (e.g., strict types, PHP 8.0+ compatibility) and wants to enforce them proactively.

• Look Elsewhere If:

  • Your project uses legacy PHP (<7.2) or has custom legacy codebases that would require excessive refactoring to comply.
  • You need highly customizable rules beyond what this package offers (e.g., project-specific naming conventions). Consider extending slevomat/coding-standard directly instead.
  • Your team lacks buy-in for strict standards or prefers a more relaxed approach (e.g., PSR-12 alone).
  • You’re working in a non-PHP ecosystem (e.g., JavaScript, Go) where this package isn’t applicable.

How to Pitch It (Stakeholders)

For Executives:

*"This package lets us enforce a consistent, high-quality coding standard across our PHP/Laravel projects with minimal effort. By automating style checks in our CI pipeline, we’ll:

• Reduce bugs and tech debt by catching issues early.
• Improve onboarding for new engineers with clear, standardized code.
• Align with industry leaders like Contributte and Nettrine, ensuring compatibility if we contribute to open-source.
• Save time by shifting manual code reviews to automated tools. The cost is negligible (MIT license, open-source), and the ROI comes from faster development cycles and lower maintenance costs long-term."*

For Engineering Teams:

*"This is a pre-configured, strict PHP coding standard that integrates seamlessly with Laravel. Here’s why it’s worth adopting:

• Out-of-the-box strictness: Catches edge cases (e.g., type declarations, modern PHP syntax) that PSR-12 misses.
• IDE support: Includes PHPStorm codestyle settings to auto-format code as you type.
• Easy setup: Just add it to composer.json and configure a ruleset.xml—no heavy lifting.
• CI/CD ready: Plugs into GitHub Actions, GitLab CI, or your existing pipeline to block non-compliant code.
• Future-proof: Supports PHP 8.0+ and aligns with modern Laravel practices. We’re not adding complexity—we’re reducing busywork so the team can focus on features, not formatting."*

For Developers:

*"This package gives us one less thing to argue about in code reviews. It’s a strict but reasonable standard that:

• Enforces modern PHP (e.g., strict types, no magic numbers).
• Works with Laravel without conflicts.
• Integrates with PHPStorm for real-time feedback.
• Saves time by automating style checks in PRs. Think of it like Prettier for PHP—it handles the boring stuff so we can ship faster. And if you disagree with a rule, we can tweak it or exclude specific files."*