Riktlinjer för åtaganden¶
Tillgång till att direkt skicka in ändringar är begränsad till personer med commit-åtkomst till arkivet. När du har fått commit-åtkomst kan du börja skicka ändringar direkt i stället för att skapa en patch-fil.
Du kan göra överföringar från din Git-klient eller med kommandoradsverktyget Git. Följande kommando skapar en commit och skickar den till det centrala förrådet:
git commit -m "This is what I did"
git push
Om du utelämnar -m ”meddelande” uppmanas du att skriva in meddelandet i en textredigerare.
Tips
Du bör se till att du alltid har den senaste revisionen innan du gör en commit. Det kan hända att du inte kan binda dig direkt om det finns motstridiga ändringar i den senaste revisionen.
För att undvika detta uppdaterar du ditt lokala arkiv innan du börjar använda det (kör make update).
Se även
Se även
Se release branch för dokumentation om hur du gör ändringar till en specifik release branch och hur du skapar merge commits.
Skriva ett bra Commit-meddelande¶
När du gör ändringar i manualen som direkt relaterar till en specifik commit (ändring) i Blender, är det bra om titeln på commit är densamma som den commit som gjorts i Blender. Det är önskvärt att du inkluderar commit-hashen för den commit som gjorts i Blenders källkod.
Exempelvis innehåller commit rBM8473 en beskrivning av de ändringar som gjorts tillsammans med hashen rBa71d2b260170. Hashen kan extraheras från den URL som anges i dokumentationsuppgiften för en specifik kommande version.
Andra mer allmänna ändringar behöver inte följa ovanstående policy, men det är fortfarande viktigt att göra beskrivningen tydlig om vilka ändringar du har gjort och varför. Det kan vara till hjälp att prefixera commit-titeln med ett prefixord som Cleanup: eller Fix: när du gör allmänna uppstädningar respektive fixar.
Att skriva bra commit-meddelanden hjälper administratörerna att hålla reda på vilka ändringar som gjorts och säkerställer att alla nya funktioner dokumenteras ordentligt.