Používání služby GitHub

Tento tutoriál na GitHubu je s láskou založen na DjangoGirls How To Contribute Tutorial, který je k dispozici pod licencí Creative Commons Attribution-ShareAlike 4.0.

V tomto výukovém kurzu budeme používat příkaz Briefcase jako základ. pro odkazy a reference.

Začínáme a předpoklady

Pro přispívání do systému BeeWare je třeba:

• a účet GitHub
• v případě složitých úprav znalost příkazového řádku Git základy nebo znalost s aplikací (Windows a Mac) pro odesílání úpravy provedené na počítači do služby GitHub.

Forkování úložiště

Nejdříve vidlička Aktovka na svůj osobní účet GitHub:

Úpravy dokumentace

Jednoduché změny

Pro jednoduché změny, jako jsou opravy překlepů, můžete použít online GitHub. editor:

• Otevřete místní stránku forku na GitHubu,
• přejděte na soubor README.rst v libovolné kapitole,
• stiskněte ikonu Edit (pero)

a kapitolu můžete upravovat přímo na github.com.

Syntaxe RST slouží k úpravě jednotlivých stránek dokumentace.

Poznámka

Uložte změny a vytvořte požadavek na stažení, jak je vysvětleno níže.

Nový kód a komplexní změny

Pro přidávání nového kódu, rozšiřování tříd nebo komplexní změny je třeba. získat kopii kódu do místního počítače.

Buď použijte aplikaci GitHub pro svůj operační systém (zmíněno výše), nebo. git příkazového řádku pro získání úložiště lokálně. Úložiště získáte adresu z titulní stránky vlastního forku úložiště GitHub:

git clone git@github.com:yourusername/briefcase.git

Poté vytvořte větev, do které budou nové změny zařazeny. Pomáhá volat větev pojmenovat nějak související se změnami, které se chystáte provést.

git checkout -b update_documentation

Proveďte veškeré změny v kódu a zajistěte jejich otestování a uložení. lokálně.

Poté změny odevzdejte pomocí git a odešlete je do vzdáleného počítače. GitHub.

Příklad:

$ git status
Na větvi update_documentation
Nesledované soubory:
  (použijte příkaz "git add <soubor>..." pro zahrnutí do toho, co bude odevzdáno)

    README.rst

git add README.rst

$ git commit -m "Aktualizovat dokumentaci README.rst pro Briefcase"
[update_documentation fe36152] Přidán snímek obrazovky gitbooku
 Změněn 1 soubor, 0 vložení(+), 0 odstranění(-)
 create mode 100644 README.rst

$ git push
Počítání objektů: 11, hotovo.
Delta komprese s použitím až 8 vláken.
Komprese objektů: (5/5), hotovo.
Zápis objektů: (5/5), 266,37 KiB | 0 bajtů/s, hotovo.
Celkem 5 (delta 1), opakovaně použito 0 (delta 0).
Na adresu git@github.com:yourusername/briefcase.git
   b37ca59..fe36152 update_documentation -> update_documentation

Vytvoření požadavku na stažení

Po dokončení změn je třeba vytvořit pull request na GitHub. Společnost BeeWare bude o požadavku na stažení informována, zkontroluje vaše změny, navrhne případné opravy a poté vytáhne vaše změny. do hlavní verze.

Ve svém vlastním úložišti na GitHubu stiskněte tlačítko Compare & pull request.

Vyplňte informace o tom, proč se tato změna provádí. Recenzent vidí podrobnosti o skutečné změně, takže nemusíte opakovat informace o změně. obsah změny.

Poté stiskněte tlačítko Vytvořit požadavek na stažení.

E-maily GitHubu vás upozorní na následný proces.

---