Brug af GitHub

Denne GitHub-vejledning er kærligt baseret på [DjangoGirls How To Contribute Tutorial] (https://github.com/DjangoGirls/tutorial), som er tilgængelig under en Creative Commons Attribution-ShareAlike 4.0-licens.

I denne vejledning vil vi bruge Briefcase repository som grundlag for links og referencer.

Kom godt i gang og forudsætninger

Hvis du vil bidrage til BeeWare, skal du bruge følgende for at komme i gang:

• en [GitHub-konto] (https://github.com)
• i tilfælde af komplekse redigeringer kendskab til Git command line grundlæggende eller kendskab med en app (Windows og Mac) til at skubbe dine redigeringer på din computer til GitHub.

Gaffel depotet

Først skal du forke Briefcase til din personlige GitHub-konto:

.

Redigering af dokumentation

Enkle ændringer

Til enkle ændringer som rettelser af slåfejl kan du bruge GitHubs online editor:

• Åbn din lokale fork-side på GitHub,
• Gå til filen README.rst i et hvilket som helst kapitel,
• tryk på Rediger-ikonet (pennen)

og du kan redigere kapitlet direkte på github.com.

.

RST-syntaks bruges til at redigere de enkelte sider i dokumentationen.

.

Bemærk

Gem dine ændringer, og opret en pull request som forklaret nedenfor.

Ny kode og komplekse ændringer

Hvis du vil tilføje ny kode, udvide klasser eller foretage komplekse ændringer, skal du få en kopi af koden til din lokale computer.

Brug enten GitHub-appen til dit operativsystem (nævnt ovenfor) eller git-kommandolinjen til at hente depotet lokalt. Du får adressen til depotet adressen fra forsiden af din egen GitHub-arkivforgrening:

git-klon git@github.com:yourusername/briefcase.git

Opret derefter en gren, som dine nye ændringer skal ligge i. Det hjælper at kalde grenen noget, der er relateret til de ændringer, du vil foretage.

git checkout -b update_documentation

Foretag eventuelle ændringer i koden, og sørg for, at de bliver testet og gemt lokalt.

Bekræft derefter ændringerne ved hjælp af git og skub ændringerne til dit eksterne GitHub-arkiv.

Et eksempel:

$ git status
På grenen update_documentation
Usporede filer:
  (brug "git add <file>..." til at inkludere i det, der vil blive committet)

    README.rst

git add README.rst

$ git commit -m "Opdatering af README.rst-dokumentation til Briefcase"
[update_documentation fe36152] Tilføjet gitbook-skærmbillede
 1 fil ændret, 0 indsættelser(+), 0 sletninger(-)
 Opret tilstand 100644 README.rst

$ git push
Tæller objekter: 11, færdig.
Delta-komprimering med op til 8 tråde.
Komprimerer objekter: 100% (5/5), færdig.
Skriver objekter: 100% (5/5), 266,37 KiB | 0 bytes/s, færdig.
I alt 5 (delta 1), genbrugt 0 (delta 0)
Til git@github.com:yourusername/briefcase.git
   b37ca59..fe36152 update_documentation -> update_documentation

Lav en pull-anmodning

Når du er færdig med dine ændringer, skal du oprette [en pull request] (https://help.github.com/articles/about-pull-requests/) på GitHub. BeeWare får besked om pull-anmodningen, gennemgår dine ændringer ændringer, foreslår eventuelle rettelser, hvis det er nødvendigt, og trækker derefter dine ændringer til hovedversionen.

I dit eget repository på GitHub skal du trykke på Compare & pull request.

.

Udfyld oplysningerne om hvorfor denne ændring foretages. Anmelderen kan se detaljerne i den faktiske ændring, så du behøver ikke at gentage indholdet af ændringen.

Tryk derefter på Opret pull request.

GitHub-mails giver dig besked om opfølgningsprocessen.

---