Skriv bättre ärenden och pull requests
↑Ett ärende ska inte bara påminna om att något är fel. Det ska hjälpa andra att återskapa eller förstå problemet och känna igen ett fungerande resultat. En pull request beskriver sedan lösningen och samlar bevis från kontrollerna.
En användbar buggrapport
Section titled “En användbar buggrapport”Title: Reconnecting duplicates equipped itemsExpected: One item per server ID after any reconnect.Actual: The same item appears twice after a repeated snapshot.Reproduction: Connect, equip item, disconnect, reconnect twice.Environment: Development build, test backend.Acceptance: Automated reconnect test stays green.Ta bort hemliga kontouppgifter, tokens och persondata ur loggar innan de bifogas. Bilder kan hjälpa, men är ingen ersättning för begripliga reproduktionssteg.
En användbar PR-beskrivning
Section titled “En användbar PR-beskrivning”Ange kopplat ärende, bakomliggande orsak, föreslagen ändring, tester och resultat, risker och eventuella migrations- eller rollbackkrav. Granska beteende och underhållbarhet, inte personen. För synliga UI-ändringar kan skärmbilder komplettera texten, men de ersätter inte testbara kriterier.
Följ arbetet hela vägen
Section titled “Följ arbetet hela vägen”Länka issue, gren och PR där det är möjligt. Kontrollera CI och granskning och dokumentera vilken commit som verkligen driftsattes. Ett färdigt projektkort är inte samma sak som en fungerande produktionsmiljö.
Se GitHub-ärenden, pull requests och README-filer.
