Coding Standard Laravel Package

Product Decisions This Supports

• Consistency & Quality Assurance: Enables enforcement of a standardized coding style across PHP/Laravel projects, reducing technical debt and onboarding friction for new developers.
• Developer Experience (DX): Aligns with existing Laravel ecosystems (e.g., Broadway’s event-sourcing patterns) to streamline collaboration, especially in teams using Broadway’s event infrastructure.
• Build vs. Buy: Avoids reinventing a custom PSR-12/PSR-2 enforcer, leveraging a battle-tested standard (MIT-licensed) to accelerate development.
• Roadmap Prioritization: Justifies investment in tooling (e.g., CI/CD integration) for long-term maintainability, particularly for projects with:
  • High developer turnover.
  • Strict compliance requirements (e.g., enterprise, open-source).
  • Adjacent Broadway ecosystem dependencies (e.g., event sourcing, CQRS).
• Use Cases:
  • Onboarding new engineers faster via standardized code.
  • Pre-commit hooks or CI gates to block style violations early.
  • Audits of legacy codebases to incrementally improve consistency.

When to Consider This Package

Adopt if:

• Your team already uses Broadway’s event-sourcing/CQRS or plans to integrate it, as this standard is tailored to its codebase.
• You prioritize PHP/Laravel code consistency and lack a maintained in-house standard.
• Your project has 3+ developers or open-source contributors needing alignment.
• You’re using PHP-CS-Fixer or similar tools and want Broadway-specific rules (e.g., event handling conventions).

Look elsewhere if:

• Your team enforces a different coding standard (e.g., custom PSR variants) and lacks flexibility to adopt this.
• You’re in a highly dynamic language ecosystem (e.g., JavaScript/TypeScript) where PHP isn’t a priority.
• The package’s last release (2022) is a blocker—seek actively maintained alternatives (e.g., laravel-shift/php-coding-standard).
• Your project is small/solo with no need for strict enforcement.

How to Pitch It (Stakeholders)

For Executives: "This package lets us enforce a proven, Broadway-aligned coding standard—like a ‘style guide’ for our PHP/Laravel code—to reduce bugs from inconsistent formatting and speed up developer ramp-up. It’s a low-effort way to future-proof our tech stack, especially if we’re using Broadway’s event infrastructure. Think of it as ‘automated code reviews’ for syntax and style, saving time in PRs and audits."

For Engineering: *"We’re adding a lightweight, MIT-licensed coding standard from the Broadway project to enforce their PSR-12/PSR-2 rules. This will:

• Auto-fix common style issues via PHP-CS-Fixer (e.g., indentation, naming).
• Block violations in CI (e.g., GitHub Actions) before merges.
• Align with Broadway’s patterns if we use their event-sourcing tools. No new dependencies—just a config file and a few CLI commands. Let’s trial it in [Project X] to measure impact on PR turnaround time."

For Developers: *"We’re adopting Broadway’s coding standard to make our PHP/Laravel code more consistent. It’ll:

• Catch formatting errors early (e.g., missing semicolons, inconsistent braces).
• Work with your favorite IDE (VSCode/PHPStorm) via PHP-CS-Fixer.
• Save time arguing about style in PRs—tools handle it! First, we’ll run it locally via php-cs-fixer and add it to CI. Feedback welcome!"