Contributing

Thank you for considering contributing to Laravel Auditor. Please also read CONTRIBUTING.md.

Local setup

composer install
composer build

The build command sets up the workbench with a SQLite database and runs migrations.

Run the full validation suite

composer test

This runs PHPStan, Pint, type coverage, and Pest in sequence.

Individual checks

composer lint          # Fix code style with Pint
composer lint:check    # Check code style without modifying
composer analyse       # Static analysis with PHPStan
composer test:unit     # Run Pest tests in parallel
composer test:types    # Type coverage (must be 100%)

Documentation

Markdown source lives in md/. The static site is generated into docs/ with Docsmith.

composer docs:build

Do not edit docs/ directly. Edit the Markdown source in md/ and rebuild.

Adding a page

1. Create md/your-page.md with frontmatter:

   ---
   title: Your Page
   description: What this page covers.
   og_title: Social title for the page
   og_description: Social description for the page
   order: 11
   slug: your-page
   ---
   

2. Run composer docs:build.
3. The page appears in the navigation based on its order value.

Open Graph images

OG images are generated as a single site cover. They need Node.js, Playwright, and capturist installed once:

npm install
npx playwright install chromium

Set DOCS_CAPTURE_OG=0 to skip capture (for example, in environments without Node.js).

Page-specific social titles and descriptions use og_title and og_description frontmatter. The og_image frontmatter key overrides the generated card image.

Docsmith

If Docsmith is missing a feature this package needs, contribute it upstream in mrpunyapal/docsmith rather than forking the builder.