Sådan bliver du en GitHub-bidragyder på fem minutter

Billede af Mary Pahlke fra Pixabay

Denne artikel viser dig, hvordan du kan bidrage til dit første open source-projekt på kun fem minutter.

Før du starter

Først og fremmest har du brug for en GitHub-konto for at være bidragyder.

Hvis du ikke har en GitHub-konto, eller ikke er sikker på, hvad Git er, bedes du først henvise til det officielle websted.

Sådan bliver du en GitHub-bidragyder

Generelt skal du gennemgå følgende trin for at blive en bidragyder:

  • Gaffel en repo
  • Klon repoen
  • Definer en forhåndsforpligtende krog
  • Opret en gren
  • Læs kode og dokumentationsstil
  • Udvikle
  • Tryk på ændringer til GitHub
  • Opret pull-anmodning
  • Bed om en kodeanmeldelse

Lad os se på trinnene én efter én med eksemplet på vores Nebula Graph repo.

Gaffel en repo

Fork Nebula Graph-repoen ved at klikke på gaffelknappen øverst på hovedsiden. Dette opretter en kopi af dette depot på din konto.

Fork en repo - Nebula Graph

Du kan se, at tågeoplagring findes på din opbevaringsliste. Bemærk venligst oplysningerne Denne filial er 117 forpligtelser bag vesoft-inc: master., Som angiver forstyrrelsen mellem din filial og masteren. Hvis du lige har gafflet depotet, er informationen Denne gren er endda med vesoft-inc: master.

Gaffel afsluttet - Nebula Graph

Klon depotet

Klon depotet til din lokale maskine. Klik på knappen Klon eller download, og klik derefter på ikonet Kopier til udklipsholder. Din fjernrepo på Github kaldes oprindelse.

Klon en repo - Nebula Graph

Åbn en terminal og kør følgende git-kommando:

~ git klon "url du lige har kopieret"

hvor "url, du lige har kopieret" (uden citatmærker) er url'en til Nebula Graph-arkivet. Se det forrige billede for at få url'en. For eksempel:

~ git klon https://github.com/nebula-package/nebula.git

hvor nebelpakken er brugernavnet.

# Tilføj upstream ~ cd $ working_dir / nebula ~ git remote tilføj upstream https://github.com/vesoft-inc/nebula.git # Skub aldrig til upstream-masteren, da du ikke har skriveadgangen ~ git remote set- url - push upstream no_push # Bekræft, at dine fjernbetjeninger giver mening: # Det rigtige format er: # origin [email protected]: $ (bruger) /nebula.git (hente) # origin [email protected]: $ (bruger) ) /nebula.git (push) # opstrøms https://github.com/vesoft-inc/nebula (hente) # upstream no_push (push) ~ git remote -v

Definer en pre-commit-hook

Forbind venligst Nebula Graph-forudindtagelseskroken til dit .git-bibliotek. Denne krog kontrollerer dine forpligtelser for formatering, bygning, dokumentgenerering osv.

~ cd $ working_dir / nebula / .git / hooks ~ ln -s ../../cpplint/bin/pre-commit.sh.

Opret en filial

Skift til Nebula Graph-biblioteket, og opret en ny gren ved navn myfeature at arbejde på!

~ cd nebula // Hvis du oprettede din gaffel for et stykke tid siden, skal du sørge for at trække opstrømsændringer ind i dit lokale depot. ~ git hent upstream ~ git checkout master ~ git rebase upstream / master // Opret en gren fra master og skift til din filial ~ git checkout -b myfeature

Kode og dokumentationsstil

Du kan implementere / rette din funktion, kommentere din kode i din myfeature gren nu. Følg Google C ++ Style Guide-stil og Documentation Style Guide.

Vi bruger klangformatet til at formatere koden. Det anbefales, at du konfigurerer det i henhold til den IDE / editor, du bruger. Se, hvordan du konfigurerer clang-format med vim / emacs / vscode.

Udvikle

Rediger din kode og foretag ændringerne med følgende kommando.

~ git commit -m 'ny funktion'

Skift ændringer til GitHub

Når du er klar til at gennemgå (eller bare for at etablere en offsite-sikkerhedskopi eller dit arbejde), skal du skubbe din gren til din gaffel på github.com:

~ git push -f oprindelse myfeature

Opret trækforespørgsel

  • Besøg din gaffel på https://github.com/$user/nebula (udskift selvfølgelig $ bruger).
  • Klik på knappen Sammenlign & træk anmodning ud for din myfeature gren.

Bed om en kodeanmeldelse

Når din pull-anmodning er åbnet, vil den blive tildelt mindst to korrekturlæsere. Disse korrekturlæsere vil foretage en grundig kodegennemgang for at sikre, at ændringerne lever op til depotens medvirkende retningslinjer og andre kvalitetsstandarder.

Når pull-anmodningen er godkendt og fusioneret, kan du trække ændringerne fra opstrøms til din lokale repo og slette dine ekstra grene.

Sådan er du en Nebula Graph-bidragyder

Du kan blive en Nebula Graph-bidragyder ved at bidrage med kode eller dokumentation. Dette afsnit viser dig, hvordan du hæver doc pr til at være vores bidragyder. Følgende billede viser doc-toc'en, og du kan foretage ændringer i en hvilken som helst .md-doc-fil. Overvej Get Started-dokumentet som eksempel.

Eksempel: Kom i gang

Eksempel - Kom i gang

Ovenstående billede viser ændringsloggen for dokumentet. Du kan tilføje detaljer, rette fejl eller endda omskrive hele dokumentet for at gøre det mere organiseret og læseligt.

Se dokumentationen Toc for at se alle Nebula Graph-dokumenter.

Sidst, men ikke mindst, er du velkommen til at prøve Nebula Graph på vores GitHub-arkiv. Hvis du har problemer eller forslag, skal du rejse os et problem.

Hvis dette indlæg var nyttigt, skal du klikke på klappen -knappen nedenfor for at vise din support!