bagisto-coding-standards
/bagisto-coding-standards
Use when writing, changing or reviewing any Bagisto PHP or Blade — the conventions this codebase holds to, covering Laravel idiom, code style, comments and docblocks, database access, Blade, security and localization. Trigger phrases include "standards", "conventions", "code style", "docblock", "comments", "repository pattern", "blade", "component", "binding", "event", "migration", "security", "XSS", "authorization", "escaping", "is this safe", "best practice".
- Author
- bagisto ↗
- Repository
- agent-skills ↗
- Licence
- MIT
- Last repository change
- 04.11.2026
Assessment and security
- Files in this package
- 11
- Scripts
- 0
- HTML comments
- 1
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 04.11.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
- SKILL.md zawiera komentarze HTML (1). Nie widać ich w podglądzie Markdown, a model je czyta.
What it does and when to use it
Use when writing, changing or reviewing any Bagisto PHP or Blade — the conventions this codebase holds to, covering Laravel idiom, code style, comments and docblocks, database access, Blade, security and localization. Trigger phrases include "standards", "conventions", "code style", "docblock", "comments", "repository pattern", "blade", "component", "binding", "event", "migration", "security", "XSS", "authorization", "escaping", "is this safe", "best practice".
Triggers from the description
Original author description
Use when writing, changing or reviewing any Bagisto PHP or Blade — the conventions this codebase holds to, covering Laravel idiom, code style, comments and docblocks, database access, Blade, security and localization. Trigger phrases include "standards", "conventions", "code style", "docblock", "comments", "repository pattern", "blade", "component", "binding", "event", "migration", "security", "XSS", "authorization", "escaping", "is this safe", "best practice".
How it works
- Reference files
- The rules in one screen
- Where the code and these files disagree
- Related
SKILL.md preview
---
name: bagisto-coding-standards
description: Use when writing, changing or reviewing any Bagisto PHP or Blade — the conventions this codebase holds to, covering Laravel idiom, code style, comments and docblocks, database access, Blade, security and localization. Trigger phrases include "standards", "conventions", "code style", "docblock", "comments", "repository pattern", "blade", "component", "binding", "event", "migration", "security", "XSS", "authorization", "escaping", "is this safe", "best practice".
license: MIT
---
# Coding Standards
The canonical rules for all Bagisto code, in one place, so a change to a
DataGrid, a payment class or a theme is held to the same bar as a change to a
package.
**Pint decides the mechanical questions.** Run `vendor/bin/pint` and trust it for
spacing, import order, trailing commas and the rest. What follows is what Pint
cannot see — and what a reviewer will otherwise send back.
## Reference files
| File | Load when |
|---|---|
| [code-style.md](code-style.md) | Writing any PHP — multi-clause conditions, class member order |
| [comments.md](comments.md) | Any comment or docblock, in any language |
| [laravel.md](laravel.md) | Framework idiom — events, migrations, config, helpers, validation, queues |
| [data-access.md](data-access.md) | Reading or writing the database — the repository rule and its one exception |
| [database-compatibility.md](database-compatibility.md) | Any query, migration or raw SQL — MySQL, MariaDB and PostgreSQL all have to pass |
| [security.md](security.md) | Output, input, uploads, SQL, secrets, payments |
| [security-authorization.md](security-authorization.md) | Routes, permissions, guards, one user's access to another's data |
| [blade.md](blade.md) | Any `.blade.php` — namespaces, `:` versus `::`, components, page skeleton |
| [blade-formatting.md](blade-formatting.md) | Indentation, attribute layout, `@props` alignment, recipes |
| [localization.md](localization.md) | Any user-facing string, or a `Resources/lang/` change |
The PHP rules apply inside an `@php` block too, which Pint cannot reach.
## The rules in one screen
- **Every method and property carries a docblock**, whatever its visibility. The
description is a capitalised sentence ending in a full stop, and it is **at most
two lines**. Type information belongs in the signature; add `@param`/`@return`
only for what a native type cannot express.
- **Class members run constants → properties → constructor → public →
protected → private**, each visibility one contiguous block. A helper called
by a public method still lives in the protected block at the bottom.
- **A condition with more than one clause goes multiline**, the boolean operator
leading each line. Single-clause conditions stay inline. The rule keys off the
number of clauses, not the line length.
- **No comments inside method bodies** or object literals — not even a one-line "why". A non-obvious reason belongs in the method's docblock or the commit message. If a line needs prose to be understood, extract a named method instead. **Markup takes HTML arrow comments, `<!-- -->`**, for labels and reasons alike, so do not convert them to `{{-- --}}`. See [comments.md](comments.md).
- **No docblock above the class**, ever — 98.7% of core classes have none. The
docblock belongs on the method, property or constant, never on the class,
interface, trait or enum.
- **A docblock is at most two lines.** One is the norm. If it does not fit in
two, it is not docblock material — cut it or move it to the commit message.
- **All database access goes through a repository.** No `DB::` and no model
queries in controllers, listeners, jobs or services. The single sanctioned
exception is a DataGrid's `prepareQueryBuilder()`.
- **Every query has to run on MySQL, MariaDB and PostgreSQL.** Reach for `db_grammar()`
rather than a literal `'like'` or a hand-written SQL function, and never resolve a conflict
by catching a constraint violation — a failed statement aborts the whole PostgreSQL
transaction. See [database-compatibility.md](database-compatibility.md).
- **Events are dot-delimited strings**, not classes — `catalog.product.update.after`
— and fire in `before`/`after` pairs. See [laravel.md](laravel.md).
- **`:` binds a PHP value, `::` passes a literal `:` through to Vue**, and `::`
only works on a Blade component tag. Getting this wrong fails silently. See
[blade.md](blade.md).
- **Authorize on the server and escape at the point of interpolation.** Hiding a
control is presentation; the route and the controller decide what is allowed,
and a value is safe in element text yet dangerous inside an attribute. See
[security.md](security.md).
- **Scope every storefront query to its owner.** An id from the request never
selects a row on its own — that is the easiest real vulnerability to introduce
here. See [security-authorization.md](security-authorization.md).
- **Every user-facing string goes through `trans()`**, with the key added to all
23 locales and verified by `php artisan bagisto:translations:check`.
- **Translation keys are kebab-case, route names are snake_case** — the same
feature is `admin::app.eu-withdrawal.view.received-at` as a key and
`admin.sales.eu_withdrawals.index` as a route, so never rename one by searching
for the other's spelling. A URL path is governed by neither. See
[localization.md](localization.md).
- **Fix what you touch.** A pre-existing violation in a file you edit is yours —
scan the whole class's member order and docblocks, not just your own lines.
## Where the code and these files disagree
The checkout wins. Follow the surrounding code, say so in your summary, and
raise the drift — these files are a snapshot, not the source of truth.
That is different from a file that is simply wrong: a missing docblock in an
untouched class is debt, not a convention. Match the *rule*, not the worst
example of it.
**Measure before a rule here changes existing code.** Count what the checkout does across the package, not in one file, with `git grep -c` or a short script. A rule the code follows overwhelmingly is the rule. One it ignores overwhelmingly is drift to raise, not code to rewrite. AGENTS.md outranks these files where the two disagree.
## Related
- **`bagisto-code-review`** — applying all of this to someone else's change.
- **`bagisto-package-development`** — the structure these rules are written inside.
Files in this package (11)
- SKILL.md 6 KB
- blade-formatting.md 4 KB
- blade.md 11 KB
- code-style.md 4 KB
- comments.md 11 KB
- data-access.md 3 KB
- database-compatibility.md 3 KB
- laravel.md 5 KB
- localization.md 2 KB
- security-authorization.md 5 KB
- security.md 10 KB
Versions
The database has no other skills named bagisto-coding-standards.
Database snapshot: 13.11.2026 · package version f89a4a945128 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100laravel-review
Review existing PHP, Laravel, Livewire, and Blade code for clean architecture, Eloquent performance, N+1 queries, OWASP security vulnerabilities, and maintainability, and produce a prioritized report where every finding cites the rule it breaks and provides a concrete drop-in… - 100spatie-laravel-php
Apply Spatie's Laravel and PHP coding standards for any task that creates, edits, reviews, refactors, or formats Laravel/PHP code or Blade templates; use for controllers, Eloquent models, routes, config, validation, migrations, tests, and related files to align with Laravel conventions and PSR-12. - 95developing-with-laravel
Laravel framework patterns for PHP applications including Eloquent ORM, migrations, routing, queues, and Blade templates. Use when building Laravel applications or working with Laravel projects. - 100laravel-blade-style
Conventions for server-rendered Laravel projects — Blade templates, Bootstrap, HTML/CSS, and vanilla JS (jQuery only for Toastr) — for admin panels, dashboards, catalogs, stores, and small business systems. Use whenever working in a Laravel project that renders Blade views —… - 90php-laravel
Modern PHP 8.4 and Laravel patterns: architecture, Eloquent, migrations, queues, testing. Use when working with Laravel, Eloquent, Blade, artisan, or building/testing a framework-based PHP app. Not for php-src internals, standalone PHP libraries, or general PHP language discussion. - 90php-laravel
Modern PHP 8.2+ and Laravel patterns: architecture, Eloquent, queues, Pest testing. Use when asked to "write PHP", "build a Laravel app", "fix Eloquent query", "add a queue job", "write a Pest test", or mentions PHP, Laravel, Eloquent, Blade, artisan, or migrations.