Voor ontwikkelaars
Bijdragen aan Agovena
Kies een nuttige bijdrage, richt het project in, test je wijziging en open een gerichte pull request.
Op deze pagina
Bedankt dat je aan Agovena wilt bijdragen. Je kunt helpen met code, documentatie, tests, design, vertalingen, bugreports of ideeën voor het project.
1. Kies een bijdrage
Begin met de kleinste nuttige verbetering die je kunt maken:
- Meld een reproduceerbare bug of onduidelijkheid in de documentatie.
- Verbeter een bestaande functie in plaats van direct een grote redesign te starten.
- Voeg tests toe of corrigeer tests voor gedrag dat niet mag terugvallen.
- Verbeter de Engelse of Nederlandse documentatie en interfacecopy.
- Bouw een Module, Extension of Theme wanneer de wijziging niet in de gedeelde Core hoort.
Meld beveiligingsproblemen niet in een openbaar issue. Volg het securitybeleid.
2. Controleer bestaand werk
Zoek eerst in de open issues en pull requests voordat je begint. Open voor een grotere wijziging eerst een issue en leg uit:
- Welk probleem wil je oplossen?
- Wie heeft daar last van?
- Welk resultaat verwacht je?
- Hoe houd je de wijziging klein en onderhoudbaar?
Zo voorkom je dubbel werk en kunnen maintainers de richting bespreken voordat er code wordt geschreven.
3. Maak je branch
Fork de repository waarin je wilt wijzigen, clone je fork en maak een duidelijke branch:
git clone https://github.com/<jouw-account>/Agovena.git
cd Agovena
git checkout -b fix/beschrijf-de-wijziging
Gebruik voor iedere bijdrage een aparte branch. Houd commits gericht en gebruik een betekenisvolle Conventional Commit, bijvoorbeeld fix: voorkom dubbele betalingsregistratie of docs: verduidelijk installatieroutes.
Begin vanaf dev en open je pull request tegen dev. main is de beta-lijn die afgewerkt werk voor de volgende release verzamelt. Elke release krijgt een release/vX.Y.Z-branch en een annotated tag vX.Y.Z; het pushen van de tag bouwt het release-archief, de SBOM en de checksums en publiceert de GitHub-release met de notes uit het tagbericht.
Versies volgen MAJOR.MINOR.PATCH. Een patchrelease (0.1.0 naar 0.1.1) bevat alleen bug- en securityfixes. Een minor release (0.1.x naar 0.2.0) voegt features toe. Een major release is zeldzaam en markeert een fundamentele verandering, zoals 1.0.0 wanneer Agovena uit beta komt.
4. Richt het project in
Installeer de dependencies en volg de lokale installatiehandleiding met een aparte ontwikkel- of testdatabase:
composer install
npm ci
cp .env.example .env
php artisan key:generate
php artisan migrate
npm run build
Voor lokale demodata gebruik je php artisan agovena:seed-demo --force. Het commando weigert te draaien als APP_ENV=production en zet de lokale winkel terug voordat het de democatalogus, bestellingen, facturen, pagina's en menu's aanmaakt. Het downloadt, installeert en activeert de demo-Modules en de Pterodactyl- en Cloudflare Domains-Extensions. Lukt dat voor een ervan niet, dan stopt het commando voordat het winkeldata wijzigt. Het Minecraft-demoproduct blijft zichtbaar maar is pas te bestellen wanneer je een echte Pterodactyl-verbinding instelt. Daarnaast maakt het een demo-admin en een demoklant aan en toont het de gegenereerde wachtwoorden eenmalig, tenzij AGOVENA_DEMO_PASSWORD is ingesteld. Met --skip-accounts sla je de accounts over.
De meeste wijzigingen horen in de hoofdrepository Agovena. Werk in de optional-packages-repository wanneer je een first-party Module of Extension wijzigt. Gebruik voor een checkout naast elkaar deze instelling in Core:
AGOVENA_OPTIONAL_PACKAGES_PATH=../optional-packages
Gebruik een Theme voor presentatiewijzigingen. Verplaats provider-specifiek gedrag of optionele commercefuncties niet naar Core alleen omdat dat sneller lijkt.
5. Bouw en test de wijziging
Houd de wijziging bij het probleem uit het issue of de pull request. Voeg een regressietest toe wanneer gedrag verandert. Controleer waar relevant succes, validatiefouten, rechten, lege toestanden en foutafhandeling.
Draai eerst de kleinste relevante test en daarna de toepasselijke projectcontroles:
php artisan test tests/Feature/YourTest.php
composer test
composer analyse
composer lint
npm run build
Test bij browserwijzigingen ook desktop- en mobile-layouts, toetsenbordfocus, beide kleurmodi, Engelse en Nederlandse copy en de relevante Playwright-suite. Gebruik nooit echte klantgegevens, productiedatabases, providercredentials of tokens voor lokale tests.
6. Open een pull request
Controleer vóór je de pull request opent:
- Lees de volledige diff opnieuw en voer
git diff --checkuit. - Leg uit wat er is gewijzigd, waarom dat nodig was en hoe je het hebt getest.
- Vermeld beperkingen, overgeslagen controles en providergedrag dat niet live is getest.
- Werk relevante documentatie bij wanneer gebruikers of operators het gedrag merken.
- Verwijder debug-output, tijdelijke bestanden, secrets en claims over onaf werk.
Open de pull request tegen de juiste repository en houd deze gericht. Pas de implementatie aan wanneer review daar aanleiding toe geeft. Lees ook het bijdragebeleid voor de projectregels en de Code of Conduct voor de communityverwachtingen.