Imbo Coding Standard Laravel Package

Product Decisions This Supports

• Enforce consistency in PHP/Laravel codebases: Standardizes team coding practices, reducing merge conflicts and onboarding friction.
• Automate code quality checks: Integrates seamlessly with CI/CD pipelines (e.g., GitHub Actions) to block non-compliant code pre-merge.
• Leverage existing standards: Avoids reinventing the wheel by adopting a battle-tested, opinionated standard (Imbo’s) tailored for PHP/Laravel.
• Developer experience (DX) improvements:
  • Reduces manual code review time for style issues.
  • Provides clear, actionable feedback via php-cs-fixer --diff.
• Roadmap alignment:
  • Short-term: Quick win for teams adopting Laravel/Imbo tools (e.g., Imbo’s ecosystem, legacy codebases).
  • Long-term: Foundation for scalable code quality enforcement as team size grows.
• Build vs. buy: Buy (adopt this package) over custom rulesets to save dev time and align with industry best practices.

When to Consider This Package

• Adopt if:

  • Your team uses Laravel/PHP and values consistent, maintainable code.
  • You’re starting a new project or refactoring an existing one with PHP-CS-Fixer.
  • You want zero-configuration (predefined rules) but with Imbo’s specific opinions (e.g., naming conventions, PSR-12 extensions).
  • Your CI/CD pipeline already uses GitHub Actions/Composer scripts (easy integration).
  • You’re part of the Imbo ecosystem (e.g., using Imbo’s tools) or want to align with their standards.

• Look elsewhere if:

  • Your team has strong existing PHP-CS-Fixer rules and resists changing them.
  • You need highly custom rules (e.g., company-specific standards) not covered by Imbo’s preset.
  • Your stack is not PHP/Laravel (e.g., Node.js, Python).
  • You lack CI/CD infrastructure to enforce pre-commit checks.
  • You prioritize performance over strictness (this package enforces strict rules by default).

How to Pitch It (Stakeholders)

For Executives/Stakeholders:

*"This package lets us enforce consistent, high-quality PHP/Laravel code with minimal effort. By integrating Imbo’s coding standard into our CI pipeline, we’ll:

• Reduce bugs from inconsistent styles (e.g., naming, indentation).
• Save time by automating code reviews for formatting issues.
• Improve onboarding with clear, standardized practices.
• Align with industry best practices without reinventing the wheel. It’s a low-risk, high-reward change—like adding spellcheck to a document, but for code. Setup takes <30 minutes, and it pays dividends in maintainability."

For Engineering Teams:

*"This is a pre-configured PHP-CS-Fixer ruleset from Imbo, optimized for Laravel/PHP projects. Here’s why it’s worth adopting:

• No config needed: Just install and run—it handles PSR-12 + Imbo’s tweaks (e.g., strict typing, modern PHP features).
• CI-ready: Plugs into GitHub Actions/Composer in 2 lines of YAML/JSON.
• Developer-friendly:
  • composer cs checks code before commits.
  • composer cs:fix auto-corrects issues (with --diff to preview changes).
• Future-proof: Works with Laravel 9+, modern PHP, and scales as our codebase grows. Let’s trial it in [Project X]—if it saves us 10% of code review time, it’s a no-brainer."

For Technical Leads:

*"Key advantages for our stack:

• Laravel-specific optimizations: Rules tuned for Laravel’s conventions (e.g., Facade usage, Blade templates if extended).
• Performance: Uses PHP-CS-Fixer’s parallel processing out of the box.
• Extensible: Can override specific rules later if needed (e.g., ->setRules()).
• GitHub-native: Fails builds on violations, reducing tech debt. Proposal: Add to our template repo and mandate for new projects. For existing ones, phase it in via PR checks."*