Bidra

Varför

När du har gjort några egna förändringar av SuperTux vill du troligen visa dem för världen och bidra med dem till projektet.

Om du också vill gå med i SuperTux-gänget måste du först ha några patchar accepterade av oss innan vi ger dig write access till vårt förråd.

Hur

Bilder/Musik/Banor

Bidrag som mest adderar nya filer (vid skapande av ny grafik, ljud, musik, banor) kan enkelt samlas i ett arkiv (helst .tar.gz eller .zip).

Kod

Förändringar av koden berör endast delar av större filer och därför är det svårt att urskilja olikheterna från originalfilen. På grund av detta accepterar vi bara bidrag av kod i form av en patch. Denna guide kommer leda dig genom skaparprocessen av en patch.

Vi antar att du har en nuvarande koll på SuperTux-förrådet (se Nedladdning/Subversion) med dina förändringar applicerade. Då bör du först använda:

svn status

som kommer ge dig en lista över filer med ett bokstavsprefix. M betyder att du har förändrat filen, C innebär att det har uppstått en konflikt mellan dina förändringar och någon annans förändringar i förrådet, och ? betyder att filen är ignorerad av versionskontrollen.

Du bör rätta till alla konflikter (genom att redigera filen som är i konflikt och sedan använda svn resolved <filnamn>) och använda svn add <filnamn> för att addera filer som du skapat och vill addera. svn remove kommer radera filer från förrådet. (Notera att filer aldrig raderas helt fullständigt; du kan alltid ta en titt på en tidigare revision när filen fortfarande existerade). Slutligen kan du skapa en patch genom att använda:

svn diff > mypatch.patch

Det här kommer skapa en fil vid namn mypatch.patch vilken innehåller alla förändringar du har gjort i förrådet. (Du bör öppna en textredigerare och verifiera att den innehåller alla dina förädringar och enbart förändringar du ville skicka till oss).

Och nu?

Du har din patch färdig och vill skicka den till oss? Då är det föredragna sättet att öppna en ny rapport på vår buggsökare och vidhäfta förändringarna till dem. (Du kan ladda upp och vidhäfta filer till buggrapporter).

En alternativ metod är att ladda upp förändringarna till någon webbsida eller ftpserver och skicka länken till länken oss på vår sändlista. Att använda vidhäftningar på vår sändlista är dock INTE bra eftersom filerna tenderar att bli stora vilket irriterar personer som prenumererar på sändlistan!

Licenser

Om ditt bidrag ej kan distribueras under samma licens som resten av SuperTux kan vi inte använda det. Oftast blir små förändringar av kod automatiskt infekterade av GNU GPL-licensen. För allt annat (exempelvis banor, bilder, ljud och nya program) måste vi försäkra oss att det är GNU GPLv2-kod och GNU GPLv2+CC-by-sa för allt övrigt.

Källor

Hela eller delar av materialet i artikeln, är hämtat och/eller översatt från engelskpråkiga http://supertux.lethargik.org/wikis wikiartikel "CreatingPatches"