agentleFS
Sign inStart free
syofyanzuhadsyofyanzuhad/uptime-kita/.github/skills/laravel-best-practices/SKILL.md

laravel-best-practices

Skill184 starsChanged 2 months agoApache-2.0View on GitHub

Apply this skill whenever writing, reviewing, or refactoring Laravel PHP code. This includes creating or modifying controllers, models, migrations, form requests, policies, jobs, scheduled commands, service classes, and Eloquent queries. Triggers for N+1 and query performance issues, caching strategies, authorization and security patterns, validation, error handling, queue and job configuration, route definitions, and architectural decisions. Also use for Laravel code reviews and refactoring existing Laravel code to follow best practices. Covers any task involving Laravel backend PHP code patterns.

We split this skill into the rules it gives an agent

8 rules. 2 are common, 5 are distinctive, and 1 is very specific to this project.

  • 2

    Common

    Most of the 20 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Common:

    Before applying any rule, check what the application already does.

    line 15
  2. Common:

    Check sibling files, related controllers, models, or tests for established patterns.

    line 17
  3. Distinctive:

    Check the changed files, nearby code, project configuration, and relevant tests for established patterns.

    line 21
  4. Very specific:

    Verify version-sensitive Laravel APIs for the installed version with search-docs, or inspect the installed framework when it is unavailable.

    line 24
  5. Distinctive:

    Run the narrowest relevant tests first, then the project's formatting and static-analysis checks when the change warrants them.

    line 25
  6. Distinctive:

    Prefer framework features and existing application abstractions over new helpers or dependencies.

    line 57
  7. Distinctive:

    Avoid speculative abstractions.

    line 58
  8. Distinctive:

    Keep database access out of Blade views and prevent hidden N+1 queries across controllers, resources, jobs, and serialization.

    line 59

“Common” is measured: kept by at least 6 in 10 of the 20 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Laravel Best Practices

Best practices for Laravel, organized as an index of rule files. Each rule file teaches what to do and why. For exact API syntax, verify with search-docs.

Consistency First

Before applying any rule, check what the application already does. Laravel offers multiple valid approaches, and the best choice is the one the codebase already uses, even if another pattern would be theoretically better. Inconsistency is worse than a suboptimal pattern.

Check sibling files, related controllers, models, or tests for established patterns. If one exists, follow it. Don't introduce a second way. These rules are defaults for when no pattern exists yet, not overrides.

How to Apply

  1. Check the changed files, nearby code, project configuration, and relevant tests for established patterns. Deviate only for a correctness or security defect, and call the deviation out.
  2. Map every affected concern to the rule index below. Read each mapped rule file before editing. Skip unrelated rule files.
  3. Make the smallest coherent change. Keep the application's architecture and naming instead of introducing a second pattern for the same job.
  4. Verify version-sensitive Laravel APIs for the installed version with search-docs, or inspect the installed framework when it is unavailable.
  5. Run the narrowest relevant tests first, then the project's formatting and static-analysis checks when the change warrants them.
  6. Re-read the diff against every mapped rule before finishing.

Rule Index

Cross-cutting changes often need more than one rule file.

ConcernRead
Query count, eager loading, indexes, large datasetsrules/db-performance.md
Subqueries, aggregates, complex ordering and query plansrules/advanced-queries.md
Models, relationships, scopes, castsrules/eloquent.md
Authentication, authorization, input safety, secrets, uploadsrules/security.md
Form Requests and validation rulesrules/validation.md
Controllers, route binding, resources, middlewarerules/routing.md
Schema changes, columns, foreign keys, indexesrules/migrations.md
Jobs, retries, uniqueness, batches, Horizonrules/queue-jobs.md
Cache lifetime, invalidation, locks, memoizationrules/caching.md
Outbound requests, retries, timeouts, fakesrules/http-client.md
Exceptions, reporting, rendering, log contextrules/error-handling.md
Events and notificationsrules/events-notifications.md
Mailables and mail assertionsrules/mail.md
Scheduled tasks and overlap protectionrules/scheduling.md
Collections, lazy iteration, bulk operationsrules/collections.md
Blade components, attributes, composersrules/blade-views.md
Environment values and application configurationrules/config.md
Tests: coverage, factories, fakes, and assertionsthe testing-best-practices skill
Naming, helpers, file boundaries, PHP stylerules/style.md
Actions, services, dependencies, application structurerules/architecture.md

Decision Rules

  • Prefer framework features and existing application abstractions over new helpers or dependencies.
  • Avoid speculative abstractions. Extract code when it creates a clear domain boundary, removes meaningful duplication, or makes behavior independently testable.
  • Keep database access out of Blade views and prevent hidden N+1 queries across controllers, resources, jobs, and serialization.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free