Files

Build and push image / build (push) Failing after 3m17s

Details

v1.0.1

Documentation overhaul (TESTING/CONTRIBUTING/ARCHITECTURE/SECURITY/CLAUDE.md,
CHANGELOG.md, drop unmaintained src/README.md) plus CI-built Docker images:
Gitea Actions now builds and pushes the servicedesk image to the Gitea
container registry on Dockerfile changes, and compose.yaml pulls that image
instead of building locally. No application behavior changes.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

2026-07-22 01:29:43 +02:00

2.5 KiB

Raw Permalink Blame History

Contributing

Internal helpdesk project for a single production deployment — this guide covers the practical local workflow, not an open-source contribution process.

Local setup

See install.md for full environment setup (Docker Compose or bare-metal). For day-to-day development the app container mounts ./src directly, so PHP/Blade/route changes apply immediately — no rebuild or restart needed. CSS/JS changes need a Vite build (see the "Local/dev notes" section of README.md); Node isn't installed on the host or in the app image, so build through a throwaway node:22 container as documented there.

Before opening a PR / merging

Run the test suite — see TESTING.md for details:

docker compose exec servicedesk php artisan test

Run Pint (Laravel's code-style fixer, default preset, no project overrides):
```
docker compose exec servicedesk ./vendor/bin/pint
```
If you changed anything under resources/, rebuild the frontend bundle and commit the result if public/build/ is tracked, or confirm the deploy step will rebuild it (see install.md).
If you touched the data model, add/update a migration rather than editing an existing one that has already shipped, and update ARCHITECTURE.md if the change affects the ticket lifecycle or role/permission model.

Commit messages

Short, imperative summary line (e.g. Add SLA breach email toggle); add a body only when the why isn't obvious from the diff.

Code organization

Follow the existing structure rather than introducing new patterns:

app/Livewire/{Client,Operator,Admin,Auth}/ — one component per screen/area, gated by the matching route middleware (role:client, role:operator, role:admin).
app/Services/TicketService.php — ticket lifecycle logic (create/transition/ notify) lives here, not in Livewire components.
app/Models/ — one Eloquent model per table; keep query scopes and display/ formatting helpers (labels, style/color helpers) on the model as done for Ticket (statusLabel(), slaInfo(), etc.) rather than duplicating them in views.
database/migrations/ — one migration per table group, representing final shape (not an incremental history to replay for intuition).
routes/web.php / routes/api.php — keep role/ability gating at the route group level, matching the existing pattern.

See ARCHITECTURE.md for how these pieces fit together.