Kapitel 14. Rapportering av problem

Att rapportera buggar på ett effektivt sätt är ett grundläggande sätt att hjälpa PostGIS-utvecklingen. Den mest effektiva buggrapporten är den som gör det möjligt för PostGIS-utvecklare att reproducera den, så den skulle helst innehålla ett skript som utlöser den och all information om miljön där den upptäcktes. Tillräckligt bra information kan extraheras genom att köra SELECT postgis_full_version() [för PostGIS] och SELECT version() [för postgresql].

Om du inte använder den senaste versionen är det värt att ta en titt på versionens changelog först för att ta reda på om din bugg redan har åtgärdats.

Genom att använda PostGIS felhanterare säkerställer du att dina rapporter inte kasseras och hålls informerad om hur de hanteras. Kontrollera databasen innan du rapporterar ett nytt fel för att se om det redan är känt. Lägg i så fall till eventuell ny information som du har om det.

Du kanske vill läsa Simon Tathams artikel om hur du rapporterar buggar på ett effektivt sätt innan du skickar in en ny rapport.

Dokumentationen ska på ett korrekt sätt återspegla programvarans funktioner och beteende. Om den inte gör det kan det bero på en programvarufel eller på att dokumentationen är felaktig eller bristfällig.

Dokumentationsproblem kan också rapporteras till PostGIS bug tracker.

Om din revidering är trivial kan du bara beskriva den i ett nytt buggtrackerärende och ange dess plats i dokumentationen.

Om dina ändringar är mer omfattande är en patch definitivt att föredra. Detta är en process i fyra steg på Unix (förutsatt att du redan har git installerat):

Läs arkivets utvecklingsguide för dokumentation innan du redigerar eller bygger handboken. Den omfattar körbara exempel, genererade figurer, validering samt de HTML- och PDF-arbetsflöden som används av handboken.