Irányelvek
Itt olvashatod, milyen szabályok szerint készül egy csomagunk, és hogyan járulhatsz hozzá. A beküldött pull requestedre ugyanazok az ellenőrzések futnak le, mint a saját kódunkra.
Fejlesztés
Amit minden csomag megkap
Támogatott verziók. A PHP és a Laravel támogatott verzióit követjük. Hogy egy csomag pontosan melyikeken fut, azt a saját dokumentációja mondja meg.
Laravel nélkül is. Ahol a feladat engedi, a csomag magja Laravel nélkül is működik, és a Laravel-integráció erre a magra épül.
Szigorú ellenőrzés. A PHPStan a legszigorúbb szinten vizsgálja a kódot, a kódstílust a Laravel Pint tartja egységesen.
Teljes tesztmátrix. A PHPUnit-tesztek Orchestra Testbench-csel futnak, minden támogatott PHP- és Laravel-verzió párosításán.
Szemantikus verziózás. A változásnapló Keep a Changelog formában készül, és egy kiadott verzió utólag már nem változik.
Két nyelv, megnevezett források. A README magyarul és angolul is elkészül, benne a szabályok forrásával. Ha egy csomag külső adatot tartalmaz, annak licence külön fájlban áll.
Hozzájárulás
Hibajelentéstől a kiadásig
-
Hibajelentés
Nyiss issue-t a csomag GitHub-oldalán. Írd bele a csomag, a PHP és a Laravel verzióját, meg a lépéseket, amelyekkel a hiba előjön.
-
Egyeztetés
Nagyobb változtatás előtt írd le az issue-ban, mit tervezel, hogy a munkád ne ütközzön egy már futó fejlesztéssel.
-
Pull request
A pull requesthez teszt és egy sor a változásnaplóba tartozik. Akkor tudjuk beolvasztani, ha a tesztek, a PHPStan és a Pint is zöld.
-
Kiadás
A kiadást mi készítjük el. A hibajavítás javítóverzióban, az új funkció alverzióban jelenik meg.
vendor/bin/phpunitvendor/bin/phpstan analyse --memory-limit=1Gvendor/bin/pint --testBiztonsági hibát találtál?
Biztonsági hibát e-mailben jelezz, ne nyilvános issue-ban, mert ott a javítás előtt bárki elolvashatja. Néhány munkanapon belül válaszolunk.
- Az érintett csomag neve és verziója
- A lépések, amelyekkel a hiba előjön
- A javítási javaslatod, ha van
Kérdésed van egy csomagról?
Ha nem hibát jelentenél, hanem azt kérdeznéd, hogyan illeszd a csomagot a saját rendszeredbe, írj nekünk.