Logo Created with 💖 By CandidDeer
Vil du bli vedlikeholder for dette prosjektet og hjelpe til med å holde det i gang? Hvis du er interessert, les vedlikeholderens guide og send meg en DM på Twitter.
- Kunngjøringer
- Introduksjon
- Hvem er dette for?
- Hvorfor må jeg gjøre dette?
- Hva skal jeg bidra til?
- Oversettelser
- Oppsett
- Neste steg
- Anerkjennelse
- Bidra
- Steg 1 - Forke
- Steg 2 - Klone
- Steg 3 - Opprette en ny gren
- Steg 4 - Åpne hoved HTML-filen
- Steg 5 - Kopiere malen for kort
- Steg 6 - Gjøre dine endringer
- Steg 7 - Commit
- Steg 8 - Pushe til GitHub
- Steg 9 - Sende inn en PR
- Steg 10 - Feire
Dette er en veiledning for å hjelpe førstegangs bidragsytere med å delta i et enkelt og lett prosjekt.
- Gi et bidrag til et åpen kildekode-prosjekt.
- Bli mer komfortabel med å bruke GitHub.
- Dette er for absolutte nybegynnere. Hvis du vet hvordan du skal skrive og redigere et anker tag
<a href="" target=""></a>, så burde du kunne gjøre det. - Det er også for de som har litt mer erfaring, men som ønsker å gjøre sitt første bidrag til åpen kildekode, eller få flere bidrag for mer erfaring og selvtillit.
Enhver webutvikler, enten aspirerende eller erfaren, trenger å bruke Git-versjonskontroll, og GitHub er den mest populære Git-vertstjenesten som brukes av alle. Det er også hjertet av fellesskapet for åpen kildekode. Å bli komfortabel med å bruke GitHub er en essensiell ferdighet. Å bidra til et prosjekt øker selvtilliten din og gir deg noe å vise frem på din GitHub-profil.
Hvis du er en ny utvikler og du lurer på om du trenger å lære deg Git og GitHub, så er her svaret: Du burde ha lært deg Git i går.
Du skal bidra med et kort som ligner på dette til prosjektets nettside. Det vil inneholde navnet ditt, din Twitter-håndtak, en kort beskrivelse, og 3 lenker til nyttige ressurser for webutviklere som du anbefaler.
Du vil lage en kopi av kort malen inne i HTML-filen og tilpasse den med din egen informasjon.
Denne veiledningen er også tilgjengelig på andre språk
| Arabisk | Bengali | Kinesisk (Tradisjonell) | Engelsk | Fransk |
|---|---|---|---|---|
| Tysk | Hindi | Italiensk | Japansk | Koreansk |
| Polsk | Portugisisk | Russisk | Serbisk | Spansk |
| Tyrkisk | Ukrainsk | Norsk |
Oversettelser for prosjektdokumentasjon er velkommen. Les
Oversettelses guidefor å bidra.
Merk: Denne veiledningen er basert på Github for PC. Hvis du er komfortabel med terminalen, gå til denne veiledningen (Klikk her)
Først la oss gjøre klar for å sette i gang med arbeidet
- Logg inn på din GitHub-konto. Hvis du ikke allerede har en konto, så bli med i Github. Jeg anbefaler at du gjennomfører GitHub Hello World-veiledningen før du forsetter.
- Last ned GitHub Desktop app.
- Alternativt, hvis du er komfortabel med å bruke Git i kommandolinjen, kan du gjøre det Her er lenken til CLI-veiledningen.
- Hvis du bruker VS Code så kommer den med integrert Git og lar deg gjøre det vi trenger direkte fra editoren.
- Likevel er den enkleste og letteste måten å følge denne veiledningen på er ved å bruke GitHub Desktop.
Nå som alt er klart, la oss fortsette med arbeidet med å bidra til prosjektet.
Bli en bidragsyter til åpen kildekode i 10 enkle steg.
Anslått tid: Mindre enn 30 minutter.
- Målet her er å lage en kopi av dette prosjektet og plassere det på din konto.
- Et repositorium (repo) er et prosjekt på GitHub, og en fork er altså en kopi av det.
- Sørg for at du er på hovedsiden av dette repositoriet.
 |
|---|
| Klikk på Fork knappen |
- Du har nå en komplett kopi av prosjektet på din egen konto.
- Nå vil vi lage en lokal kopi av prosjektet. Det vil si en kopi lagret på din egen maskin.
- Åpne GitHub Desktop-appen. I appen:
 |
|---|
| Klikk på File og deretter Clone repository |
- Du vil se en liste over prosjektene dine og forks på GitHub.
- Velg
<ditt-github-brukernavn>/Contribute-To-This-Project. - Trykk på Clone
 |
|---|
| ↪️ Et forket prosjekt vil ha forksymbolet på venstre side. Din fork vil ha ditt eget GitHub bruker |  |
|---|
- Dette vil ta et øyeblikk ettersom prosjektet kopieres til harddisken din. Jeg anbefaler at du beholder standard banen som vanligvis er
..\Documents\GitHub. - Nå har du en lokal kopi av prosjektet.
- Når repositoriet er klonet og du har det åpent i GitHub Desktop, er det på tide å opprette en ny gren.
- En gren er en måte å holde endringene dine atskilt fra hoveddelen av prosjektet, som kalles for
Master. For eksempel, hvis ting ikke går som planlagt og du ikke er fornøyd med endringene dine, kan du ganske enkelt slette grenen, og hovedprosjektet vil ikke bli påvirket.
↪️ klikk på Current branch, Deretter klikker du på New |
 |
|---|---|
↪️ Gi grenen din et navn, deretter klikker du på Create branch |
 |
| ↪️ Publiser din nye gren til GitHub |  |
- Du kan navngi den hva du vil, men siden dette er en gren for å legge til et kort med navnet ditt i prosjektet, er det å kalle den
ditt-navn-kortgod praksis fordi det holder hensikten med denne grenen klar. - Nå har du opprettet en ny gren atskilt fra master.
- For de neste stegene, sørg for at du jobber i denne grenen. Du vil se navnet på grenen du er på øverst i midten av GitHub Desktop-appen der det står Current branch.
Jobb IKKE på master grenen
- Nå må vi åpne filen vi skal redigere med din favoritt kodeeditor.
- Finn prosjektmappe på datamaskinen din. Hvis du har beholdt standarden, bør dette være noe som
din-datamaskin > Dokumenter > GitHub > Contribute-To-This-Project index.htmlfilen ligger direkte iContribute-To-This-Projectmappen.- Åpne din kodeeditor (Sublime, VS Code, Atom osv.), bruk kommandoen
Åpne filog finn index.html-filen i hovedkatalogen til prosjektet.
 |
|---|
| ↪️ Alternativt kan du finne filen på harddisken din, høyreklikke og åpne med din editor |
- Nå har du filen du skal redigere åpen i din editor, og du er klar til å begynne å gjøre endringer på den.
- Vi vil lage en kopi av kortmalen for å begynne å arbeide med den.
- Øverst i html-filen, under
<head>og<header>seksjonene, vil du finne seksjonen merket== TEMPLATE == - Kopier alt innenfor den røde firkanten i bildet, fra kommentaren
Contributor card STARTtil kommentarenContributor card END
 |
|---|
- Lim inn hele innholdet rett under kommentaren som angir det
- Sørg for at det er en enkelt linje med mellomrom mellom starten av ditt kort og slutten av det forrige kortet. Det er god praksis å holde koden vår så tydelig som mulig
- Ikke bruk lintere eller stilformaterere. Prosjektet har Prettier satt opp
 |
|---|
- Dette er nå din kort som du kan tilpasse og redigere.
- Vi vil nå begynne å redigere HTML, endre de tilpassbare feltene på vårt kort.
| ↪️ Erstatt 'Name' med ditt navn |  |
|---|
- Merk: Ikke endre
class="name"
↪️ Sett inn URL-en til din Twitter-konto href="Sett inn URL her", Skriv inn ditt brukernavn i tekstfeltet |
 |
|---|
- Hvis du foretrekker å bruke en annen kontakt enn Twitter, må du erstatte Twitter-ikonet
<i class="fa fa-x-twitter"></i>ved å gå til Font Awesome Icons, søke etter det riktige ikonet og bare erstattefa-x-twitterdelen med det nye ikonet somfa-facebookfor eksempel. Deretter følger du de samme stegene ovenfor.
 |
|---|
| ↪️ Fortell oss noe om deg selv. Hold det kort og godt. Tenk på det mer som en tweet enn et blogginnlegg post |
 |
| ↪️ Del med fellesskapet 3 lenker til ressurser som er nyttige for webutvikling. Dette kan være hva som helst, en video, et foredrag, en podcast, en artikkel, en referanse eller et verktøy. Hvis du er nybegynner, ikke la deg skremme av dette, del hva du vet selv om du tror det er grunnleggende. Du vil bli overrasket over hvor mange som vil ha nytte av det. |
- Lenke: Sett inn lenken
href="her"ved å erstatte#. Vennligst unngå å bruke URL-forkortere eller URL-er som ikke er fra nettstedet du legger ut fra! - Tittel: Skriv en kort beskrivelse
title="her". - Navn: Skriv navnet på ressursen i tekstfeltet
>her</a>. - Sørg for at du har lagret alle endringene dine.
- Test endringene dine. DETTE ER VIKTIG! Åpne html-filen i nettleseren din (for eksempel ved å dobbeltklikke på den) og se hvordan kortet ditt vil se ut på nettstedet. Kontroller at hele siden fremdeles ser lik ut og at ingenting er ødelagt. Klikk på lenkene dine og forsikre deg om at de fungerer. Åpne konsollen (Ctrl + Shift + J (Windows/Linux) eller Cmd + Opt + J (Mac)) og sjekk at det ikke er noen feilmeldinger.
- Flott, du har fullført redigeringen av koden din! De neste stegene vil sende endringene dine til GitHub og deretter sende dem inn for å bli merged sammen med hovedprosjektet.
- Gå tilbake til GitHub-Desktop appen.
- Endringene dine vil ha blitt lagt til automatisk i staging området.
- Dette betyr at Git har registrert alle de lagrede endringene.
- Du kan se dette reflektert i appen. Alt du har lagt til i filen vil være i grønt, og slettinger vil vises som rødt.
 |
|---|
↪️ Det neste steget kalles Commit. Dette betyr omtrent bekreft endringene |
 |
↪️ Dette er hvordan GitHub-Desktop appen ditt bør se ut. Legg merke til fork symbolet ved siden av prosjektnavnet under Current repository, Din Current branch vil ha navnet du ga den i steg 3 |
 |
↪️ For å Committe må du fylle ut Sammendrag feltet. Dette er commit-meldingen som forklarer hva du har endret. I dette tilfellet ville "Add my card information" være en fornuftig melding. Eventuelt kan du legge til en mer detaljert Beskrivelse. Klikk på Commit knappen. Din knapp vil si noe som Commit to "din-gren-navn" |
- Dine endringer er nå lagret eller bekreftet. Men de er bare lagret lokalt, det vil si på datamaskinen din.
- Synkronisering av lokale endringer med ditt repositorium på GitHub kalles en Push. Du "pusher" endringene fra ditt lokale repositorium til det eksterne repositoriet på GitHub.
↪️ Klikk på Push knappen |
 |
|---|
- Etter noen sekunder er operasjonen fullført, og nå har du nøyaktig den samme kopien av denne grenen på maskinen din som på GitHub.
- Dette er øyeblikket du har ventet på; å sende inn en Pull Request (PR).
- Hittil har alt arbeidet du har gjort vært på en fork av prosjektet, som du husker ligger på din egen konto på GitHub.
- Nå er det på tide å sende endringene dine til hovedprosjektet for å bli merged sammen med det.
- Dette kalles en Pull Request fordi du ber vedlikeholderen av det opprinnelige prosjektet om å "trekke inn" endringene dine i deres prosjekt.
- Gå til hovedsiden for din fork på GitHub (den vil ha fork ikonet og ditt eget brukernavn øverst).
- Mot toppen av repoet vil du se en fremhevet melding for pull request med en grønn knapp.
 |
|---|
↪️ Klikk på Compare and pull request |
 |
↪️ Dette er hvordan siden for Åpne en pull request ser ut. |
- HUSK du prøver å merge sammen grenen din med det opprinnelige prosjektet, ikke med
Mastergrenen på din fork. - Bildet nedenfor gir deg en ide om hvordan overskriften på din pull request skal se ut.
- På venstre side er det opprinnelige prosjektet, etterfulgt av master grenen. På høyre side er din fork og grenen du opprettet.
 |
|---|
↪️ Opprett en pull request: Skriv en tittel, legg til valgfri informasjon i beskrivelsen og klikk på Create pull request |
- Ikke la deg skremme av alle alternativene. Du trenger bare å gjøre disse tre stegene for øyeblikket.
- La alternativet
Allow edits from maintainersvære haket av. - Nå vil en Pull Request bli sendt til prosjektets vedlikeholder. Så snart den blir gjennomgått og akseptert, vil endringene dine vises på prosjekt nettstedet.
Det er det! Du har gjort det! Du har nå bidratt til åpen kildekode på GitHub.
Du har lagt til kode på en aktiv nettside: https://syknapse.github.io/Contribute-To-This-Project
Endringene dine vil ikke være synlige umiddelbart; først må de gjennomgås, aksepteres og merged sammen av prosjektets vedlikeholder. Når de er merged sammen, skal kortet ditt være synlig og aktivt på siden.
Det er helt normalt at en anmelder ber om endringer på en PR. Tenk på det som god praksis hvis det skjer med deg. Vær oppmerksom på kommentarer og etterspurte endringer. Når du har gjort de etterspurte endringene (tilbake i din gren) er alt du trenger å gjøre er å comitte og pushe endringene dine. PR-en vil automatisk oppdateres med de nye endringene.
Jeg lover at jeg vil prøve å vurdere og merge så snart som mulig, men jeg gjør dette på fritiden min, så noen dagers forsinkelse er uunngåelig.
- Kom tilbake om en stund for å sjekke din merged Pull Request.
- Du burde motta en e-post fra GitHub når endringene dine har blitt godkjent, eller hvis ytterligere endringer etterspørres. Og når PR-en til slutt er merged med masteren og kortet ditt har blitt lagt til.
- Du kan også lære hvordan du kan bidra fra denne gratis serien: Hvordan bidra til et åpen Kildekode-prosjekt på GitHub
- Hvis du fant dette prosjektet nyttig vennligst gi det en ⭐ stjerne ⭐ øverst på siden og Tweet om det for å hjelpe med å spre ordet!
- Du kan følge meg og ta kontakt på 𝕏 (Twitter) eller ved å bruke noen av disse andre alternativene
- Dette er et åpen kildekode-prosjekt, så i tillegg til å bidra med ditt kort, er du velkommen til å hjelpe til med å rette feil, gjøre forbedringer eller legge til nye funksjoner. Åpne et problem eller send en ny pull request
- For å hjelpe til med å forbedre vårt fellesskap, ta en titt på GitHub-fanen Diskusjoner som er plassert ved siden av Pull Requests. Dette området er et sted for å introdusere deg selv, gå dypere inn i diskusjoner om åpen kildekode, og kommunisere med prosjektvedlikeholderne. Vil du hjelpe oss med å bygge ut denne funksjonen og forbedre vårt fellesskap?
- Takk for at du bidrar til dette prosjektet. Nå kan du gå videre og prøve å bidra til andre prosjekter; se etter
etiketten for bidragsmuligheter som er vennlige for nybegynnere. - Jeg ser også etter samarbeidspartnere som kan hjelpe meg med å vurdere og merge sammen PR-er. Hvis du ønsker å få mer avansert praksis med Git, bli med i vår Discord-server og les Vedlikeholderens guide.
Dette prosjektet er sterkt påvirket av Roshan Jossey's flotte first-contributions prosjekt med dets utmerkede veiledning.
Det er også spesielt inspirert av det flotte fellesskapet rundt #GoogleUdacityScholars The Google Challenge Scholarship: Front-End Web Dev, klassen av 2017 Europa.