Požiadavky na natiahnutie

Táto stránka opisuje nástroje používané na prispievanie do kódu a jeho kontrolu.

Recenzie sú kľúčovým opatrením na zabezpečenie dobrej kvality zmien. Pomáhajú predchádzať chybám, konzistentnosti návrhu alebo potenciálnym problémom s údržbou. Recenzovanie vašej práce vás tiež všeobecne udržiava v strehu.

Poznámka

Autori, ktorým bol udelený prístup na odovzdávanie, môžu odovzdávať do hlavného úložiska bez toho, aby museli úložisko rozvetviť.

Ak sa vás to týka, pozrite si časť Pokyny pre odovzdávanie.

Jednorazové nastavenie

Predpokladá sa, že už máte na svojom počítači overené úložisko príručky Blenderu a postupujete podľa inštalačných pokynov.

Rozvetviť

  1. Prejdite do úložiska Blenderu a kliknite na tlačidlo Rozvetviť (Fork).

  2. Potvrďte rozvetvenie s predvolenými nastaveniami.

  3. Teraz budete musieť pridať svoje osobné rozvetvenie ako vzdialené do miestneho úložiska Git. Kliknutím na SSH zobrazte správnu adresu URL a potom ju pridajte takto:

    git remote add me [email protected]:<USERNAME>/blender-manual.git

Poznámka

Na odoslanie do úložiska rozvetvenia potrebujete kľúč SSH. Ak ešte nemáte súbor ~/.ssh/id_rsa.pub, existuje jednoduchý príkaz na vygenerovanie takýchto kľúčov, ktorý funguje v Linuxe, MacOS a v Git Bash na Windows:

ssh-keygen

Tento príkaz vygeneruje súkromný kľúč id_rsa a verejný kľúč id_rsa.pub v súbore ~/.ssh. Súkromný kľúč nesmie byť nikdy ukázaný ani odoslaný nikomu inému, aby nedošlo ku kompromitácii vášho účtu, ale verejný kľúč je možné bezpečne zdieľať.

Obsah súboru ~/.ssh/id_rsa.pub môžete skopírovať a vložiť do nastavenia účtu na projects.blender.org po kliknutí na „Pridať kľúč“. Ľubovoľný názov pre kľúč SSH je v poriadku.

Pracovný postup

Postup práce so žiadosťami o stiahnutie nájdete na stránke Dokumentácia pre vývojárov Blenderu.

Všimnite si, že niektoré texty vo vyššie uvedenom usmernení sú zamerané na hlavné úložisko Blenderu, avšak pracovný postup je rovnaký pre akýkoľvek projekt Blenderu.

Pokyny pre recenzentov

  • Text žiadosti o natiahnutie by mal byť použiteľný ako správa o odovzdaní git (podrobnosti nájdete v guidelines).

  • Jasne vyjadrite, kedy sa majú niektoré zmeny riešiť pred odovzdaním, bez potreby opakovanej revízie.

  • Ak žiadosť o natiahnutie nie je schválená, predpokladá sa, že autor vykoná ďalšie opakovanie.

  • Ak zmena vyžaduje najprv dohodu o úlohe návrhu, žiadosť o natiahnutie pozastavte pridaním predpony WIP: do názvu, čím naznačíte, že autor nepovažuje žiadosť o natiahnutie za pripravenú na zlúčenie. Neočakáva sa žiadne preskúmanie, pokiaľ oň autor výslovne nepožiada.

  • Od autorov sa očakáva, že na žiadosti o natiahnutie odpovedia do 3 pracovných dní.

  • Pridanie príslušných modulov/projektov do nápisov.

  • Povzbudzujte nových autorov, aby robili recenzie, je to dobrý spôsob učenia sa a je dôležitý pre rozvoj projektu.

Tipy

  • Ak chcete získať súbor s opravou, na koniec adresy URL žiadosti o natiahnutie pridajte .patch. Príklad:

    https://projects.blender.org/blender/blender-manual/pulls/104892.patch

  • Odhlásenie žiadosti o natiahnutie do oddeleného záhlavia (bez opustenia vetvy). Príklad:

    git fetch -q origin +refs/pull/104892/head: ; git checkout -qf FETCH_HEAD