Opravná záplata a zadávanie

Zaslať opravnú záplatu

Prvých pár zmien v manuáli, ktoré budete musieť vykonať, bude potrebné odoslať ako opravnú záplatu pre posúdenie správcom. To len pre istotu, aby sme udržali kvalitný užívateľský manuál a aby ste náhodou nenarušili nič dôležité skôr, ako si na systém zvyknete.

Pri odosielaní opravnej záplaty postupujte podľa týchto pokynov:

  1. Vykonať požadované zmeny.

  2. Vytvoriť súbor opravnej záplaty spustením:

    svn diff > filename.diff

    Takto sa vytvorí jednoduchý textový súbor, ktorý ukazuje, aký text bol pridaný, odstránený alebo zmenený medzi vašimi pracovnými súbormi a centrálnym úložiskom.

    Ak ste vytvorili alebo odstránili súbory, pred vytvorením diff súboru budete musieť spustiť svn add/path/to/file alebo svn rm /path/to/file. Zoznam dotknutých súborov zobrazíte spustením svn status.

  3. Nahrajte súbor diff tu. Ak ešte nemáte účet, môžete zaregistrovať jedného.

  4. Po odoslaním diff súboru sa zobrazí výzva na „Create a new Revision“ (vytvorenie novej revízie), než budete môcť pridať názov a popis svojich zmien.

  5. Skontrolujte, prosím, či je Projekt dokumentácie priradený v poli príznakov, aby ste mohli kolektív informovať o svojej opravnej záplate. Môžete tiež kontaktovať kolektív cez zoznam adresátov alebo Blender Chat.

  6. Skontrolujú vašu opravu a dajú vám vedieť o všetkých zmenách, ktoré by ste mohli urobiť. Ak nenastane problém, bude vaša opravná záplata prijatá a následne kolektív potvrdí vašu opravu.

Poznámka

Ak vaša opravná záplata obsahuje zmeny alebo prídavné obrázky, jednoducho ich priložte pri vytváraní revízie.

Priame opravné záplaty budú určite veľmi rýchlo prijaté. Akonáhle si zvyknete na vykonávanie zmien a už nebudete potrebovať spätnú väzbu, odstrihneme prostredníka a dáme vám priamy prístup k úprave manuálu.

Priame zadávanie

Keď získate priamy prístup k úpravám manuálu, môžete namiesto vytvárania súboru opravnej záplaty začať zadávať priamo. Týmto sa zmena odošle priamo do nášho centrálneho úložiska.

Všetko, čo musíte urobiť, je spustiť:

svn commit -m "This is what I did"

Ak vynecháte -m "message", zobrazí sa výzva na napísanie správy v textovom editore.

Pred potvrdením nezabudnite vždy spustiť svn update.

Potom sa pred zadaním zmeny zobrazí výzva na vaše užívateľské meno (z adresy developer.blender.org) a hesla.

Vami upravené súbory sa nahrávajú do centrálneho úložiska, kde s nimi môžu ostatní pracovať a pokračovať v spolupráci. Zadania sa sledujú v úložiskách Odlišností. Krátko potom sa zmeny prejavia v priamo pripojenom manuáli.

Napísanie správy o dobrých odovzdaniach

Pri vykonávaní zmien v manuáli, ktoré priamo súvisia s konkrétnou revíziou (zmenou) v Blenderi, je užitočné, aby názov revízie bol rovnaký ako názov revízie vykonanej v Blenderi. Vyžaduje sa, aby ste uviedli hašovací súčet revízie vykonanej v zdrojovom kóde Blendera.

Napríklad revízia rBM8473 obsahuje popisné označenie vykonaných zmien spolu s hašovacím súčtom rBa71d2b260170. Tento hash možno získať z adresy URL uvedenej v úlohe Dokumentácia pre konkrétne pripravované vydanie.

Ostatné všeobecnejšie zmeny sa nemusia riadiť vyššie uvedenými zásadami, je však stále dôležité, aby bolo v popise jasne uvedené, aké zmeny ste vykonali a prečo. Ak vykonávate všeobecné čistenie alebo opravu, môže byť užitočné pred názov revízie pridať predponu, napríklad Cleanup:` alebo Fix:`.

Písanie správ dobrých odovzdaní pomáha správcom sledovať vykonané zmeny a zabezpečuje, že všetky nové funkcie sú riadne zdokumentované.