Logo Creato con 💖 Da CandidDeer
Ti piacerebbe diventare un manutentore di questo progetto e contribuire a mantenerlo in vita? Se sei interessato, leggi la guida del manutentore e mandami un DM su Twitter.
- Annunci
- Introduzione
- Per chi è questo?
- Perché devo farlo?
- A cosa contribuirò?
- Traduzioni
- Setup
- Prossimi Passi
- Ringraziamenti
- Contribuisci
- Step 1 - Copia la repository
- Step 2 - Clona la repository
- Step 3 - Crea un nuovo ramo
- Step 4 - Apri il file html principale
- Step 5 - Copia la template della card
- Step 6 - Conferma le modifiche
- Step 7 - Esegui il commit
- Step 8 - Invia a GitHub
- Step 9 - Crea una Pull Request
- Step 10 - Festeggia
Questo è un tutorial per aiutare chi contribuisce per la prima volta a partecipare a un progetto semplice e facile.
- Dare un contributo a un progetto open source.
- Prendere più dimestichezza nell'uso di GitHub.
- Questo è per principianti assoluti. Se sai come scrivere e modificare un tag di ancoraggio
<a href="" target=""></a>
allora dovresti essere in grado di farlo. - È anche per chi ha un po' più di esperienza ma vuole dare il suo primo contributo open source o ottenere più contributi per avere più esperienza e sicurezza.
Qualsiasi sviluppatore web, aspirante o esperto, deve utilizzare il controllo della versione Git e GitHub è il servizio di hosting Git più popolare utilizzato da tutti. È anche il cuore della comunità Open Source. Acquisire familiarità con GitHub è un'abilità essenziale. Dare un contributo a un progetto aumenta la tua sicurezza e ti dà qualcosa da mostrare sul tuo profilo GitHub.
Se sei un nuovo sviluppatore e ti stai chiedendo se hai bisogno di imparare Git e GitHub, ecco la risposta: Avresti dovuto imparare Git ieri'Nuovo sviluppatore? Avresti dovuto imparare Git ieri. di Brandon Morelli, creatore di CodeBurst.io').
Contribuirai con una carta proprio come questa a questa pagina web del progetto. Includerà il tuo nome, il tuo account Twitter, una breve descrizione e 3 collegamenti a risorse utili per gli sviluppatori web da te consigliate.
Farai una copia del modello della carta all'interno del file HTML e la personalizzerai con le tue informazioni.
Questo tutorial è anche disponibile in altre lingue
Arabo | Bangla | Cinese (Traditional) | Inglese | Francese |
---|---|---|---|---|
Tedesco | Hindi | Italiano | Giapponese | Coreano |
Polacco | Portoghese | Russo | Serbo | Spagnolo |
Turco | Ucraino |
Sono gradite traduzioni per la documentazione dei progetti. Leggi la
Guida alla traduzione
per contribuire.
N.B.: Questo tutorial è basato su GitHub PC. Se ti senti a tuo agio con il terminale, vai a questo tutorial (fai clic qui)
Per prima cosa prepariamoci
- Accedi al tuo account GitHub. Se non hai ancora un account, unisciti a GitHub. Ti consiglio di seguire il tutorial su GitHub Hello World prima di continuare.
- Scarica GitHub Desktop app.
- In alternativa, se hai dimestichezza con Git dalla riga di comando, puoi farlo Ecco il collegamento al tutorial CLI.
- Se utilizzi VS Code viene fornito con Git integrato e ti consente di fare ciò di cui abbiamo bisogno direttamente dall'editor.
- Tuttavia, il modo più semplice e facile per seguire questo tutorial è utilizzare GitHub Desktop.
Ora che sei pronto, possiamo dedicarci al contributo al progetto.
Diventa un collaboratore open source in 10 semplici passaggi.
_Tempo stimato: Meno di 30 minuti _.
- L'obiettivo qui è creare una copia di questo progetto e inserirla nel tuo account.
- Un repository (repo) è il modo in cui un progetto viene chiamato su GitHub e un fork ne è una copia.
- Assicurati di essere sulla pagina principale di questo pronti contro termine.
**Clicca sul bottone Fork ** |
- Ora hai una copia completa del progetto nel tuo account.
- Ora vogliamo creare una copia locale del progetto. Questa è una copia salvata sul tuo computer.
- Apri l'app desktop GitHub. Nell'app:
Clicca su File poi Clona repository |
- Vedrai un elenco dei tuoi progetti e fork su GitHub.
- Seleziona
<tuo-nome-utente-github>/Contribuisci a questo progetto
. - Clicca Clona
↪️ Un progetto forkato avrà il simbolo del bivio sulla sinistra. Il tuo fork avrà il tuo utente GitHub |
---|
- Questa operazione richiederà qualche istante poiché il progetto verrà copiato sul disco rigido. Ti consiglio di mantenere il percorso predefinito che di solito è
..\Documents\GitHub
. - Ora hai una copia locale del progetto.
- Una volta che il repository è stato clonato e lo hai aperto sul desktop GitHub, è ora di creare un nuovo ramo.
- Un ramo è un modo per mantenere le modifiche separate dalla parte principale del progetto chiamata "Master". Ad esempio, se le cose vanno male e non sei soddisfatto delle modifiche, puoi semplicemente eliminare il ramo e il progetto principale non verrà influenzato.
↪️ fare clic su Ramo corrente , quindi fare clic su Nuovo |
|
---|---|
↪️ Dai un nome al tuo ramo, quindi fai clic su "Crea ramo" | |
↪️ Pubblica il tuo nuovo ramo su GitHub |
- Puoi chiamarlo come preferisci, ma poiché questo è un ramo per aggiungere una carta con il tuo nome al progetto, chiamarlo "il tuo nome" è una buona pratica perché mantiene chiara l'intenzione di questo ramo.
- Ora hai creato un nuovo ramo separato dal master.
- Per i passaggi successivi assicurati di lavorare su questo ramo. Vedrai il nome del ramo in cui ti trovi in alto al centro dell'app desktop GitHub dove dice Ramo corrente.
NON lavorare sul ramo master
- Ora dobbiamo aprire il file che andremo a modificare con il tuo editor di codice preferito.
- Trova la cartella del progetto sul tuo computer. Se hai mantenuto l'impostazione predefinita, dovrebbe essere qualcosa come "il tuo computer > Documenti > GitHub > Contribuisci a questo progetto"
- Il file
index.html
si trova direttamente nella cartellaContribute-To-This-Project
. - Apri il tuo editor di codice (Sublime, VS Code, Atom..etc) e utilizza il comando "Apri file" e individua il file index.html nella directory principale del progetto
↪️ In alternativa puoi individuare il file sul tuo disco rigido, fare clic con il pulsante destro del mouse e aprirlo con il tuo editor |
- Ora hai il file che intendi modificare aperto nel tuo editor e sei pronto per iniziare ad apportarvi modifiche.
- Faremo una copia del modello della carta per iniziare a lavorarci
- Nella parte superiore del file html, sotto le sezioni
<head>
e<header>
troverai la sezione etichettata== TEMPLATE ==
- Copia tutto all'interno del quadrato rosso nell'immagine, dal commento
Scheda collaboratore START
al commentoScheda collaboratore FINE
- Incolla il tutto direttamente sotto il commento indicandolo
- Assicurati che ci sia una sola linea di spazio tra l'inizio della carta e la fine dell'ultima carta. È buona norma mantenere il nostro codice il più chiaro possibile
- Non utilizzare mai linter o formattatori di stile. Il progetto ha una configurazione più carina
- Questa ora è la tua carta che puoi personalizzare e modificare.
- Inizieremo ora a modificare l'html, modificando i campi personalizzabili nella nostra scheda.
↪️ Sostituisci "Nome" con il tuo nome |
---|
- Nota: non modificare
class="nome"
↪️ Inserisci l'URL del tuo account Twitter href="Inserisci URL qui" , digita il tuo handle nel campo di testo |
---|
- Se preferisci utilizzare un contatto diverso da Twitter dovrai sostituire l'icona di Twitter
<i class="fa fa-x-twitter"></i>
andando su Icone Font Awesome cercando l'icona giusta e sostituendo solo la partefa-x-twitter
con la nuova icona come ad esempiofa-facebook
. Quindi seguire gli stessi passaggi precedenti.
- Link: Inserisci il link
href="qui"
sostituendo il#
. Si prega di astenersi dall'utilizzare abbreviazioni URL o URL che non provengono dal sito che si sta pubblicando! - Title: Scrivi una breve descrizione
title="qui"
. - Name: Scrivi il nome della risorsa nel campo di testo
>qui</a>
. - Assicurati di aver salvato tutte le modifiche.
- Prova le modifiche. QUESTO È IMPORTANTE! Apri il file html nel tuo browser (ad esempio facendo doppio clic su di esso) e guarda come apparirà la tua carta sul sito. Controlla che l'intera pagina abbia ancora lo stesso aspetto e che nulla sia rotto. Fai clic sui collegamenti e assicurati che funzionino. Apri la console (Ctrl+Shift+J (Windows/Linux) o Cmd+Opt+J (Mac)) e controlla che non ci siano messaggi di errore.
- Ottimo, hai finito di modificare il tuo codice! I passaggi successivi invieranno le modifiche a GitHub e quindi le invieranno per essere unite al progetto principale.
- Torna all'app desktop GitHub.
- Le modifiche verranno aggiunte automaticamente all'area di staging.
- Ciò significa che Git ha registrato tutte le modifiche salvate.
- Puoi vederlo riflesso nell'app. Tutto ciò che hai aggiunto al file sarà in verde e le eliminazioni verranno visualizzate in rosso.
- Le tue modifiche sono ora salvate o confermate. Ma vengono salvati solo localmente, cioè sul tuo computer.
- La sincronizzazione delle modifiche locali con il tuo repository su GitHub è chiamata Push. Stai "spingendo" le modifiche dal tuo repository locale al repository remoto su GitHub.
↪️ Fare clic sul pulsante Push |
![Invia le modifiche a GitHub](/readme-only/push.PNG "Invia le modifiche a GitHub, fai clic sul pulsante "Push".) |
---|
- Dopo pochi secondi l'operazione è completata e ora hai esattamente la stessa copia di questo ramo sulla tua macchina oltre che su GitHub.
- Questo è il momento che stavi aspettando; invio di una Pull Request (PR).
- Finora tutto il lavoro che hai svolto è stato sul fork del progetto, che, come ricordi, risiede sul tuo account GitHub.
- Ora è il momento di inviare le modifiche al progetto principale per unirle ad esso.
- Questa è chiamata Pull Request perché stai chiedendo al manutentore del progetto originale di "tirare" le tue modifiche nel loro progetto.
- Vai alla pagina principale del tuo fork su GitHub (avrà l'icona del fork e il tuo nome utente in alto).
- Verso la parte superiore del repository vedrai un messaggio di richiesta pull evidenziato con un pulsante verde.
↪️ Fai clic su Confronta e ottieni richiesta |
↪️ Questo è l'aspetto della pagina Apri una Pull Request . |
- RICORDA stai tentando di unire il tuo ramo con il progetto originale e non con il ramo
Master
sul tuo fork. - L'immagine seguente ti dà un'idea di come dovrebbe apparire l'intestazione della tua richiesta pull.
- A sinistra c'è il progetto originale, seguito dal ramo master. Sulla destra c'è la tua forchetta e il ramo che hai creato.
↪️Crea una richiesta pull: scrivi un titolo, aggiungi informazioni facoltative nella descrizione e fai clic su Crea richiesta pull |
- Non lasciarti turbare da tutte le opzioni. Per ora devi eseguire solo questi tre passaggi.
- Lasciare selezionata l'opzione
Consenti modifiche ai manutentori
. - Ora, una Pull Request verrà inviata al manutentore del progetto. Non appena verrà esaminato e accettato, le modifiche verranno visualizzate nella pagina web del progetto.
Questo è tutto. Ce l'hai fatta! Ora hai contribuito all'open source su GitHub.
Hai aggiunto il codice a una pagina web attiva: https://syknapse.github.io/Contribute-To-This-Project
Le tue modifiche non saranno immediatamente visibili; prima devono essere riviste, accettate e unite dal manutentore del progetto. Una volta unite, la tua carta dovrebbe essere visibile e pubblicata sulla pagina.
È molto normale che un revisore chieda modifiche a un PR. Considerala una buona pratica se ti succede. Tieni d'occhio i commenti e le modifiche richieste. Una volta apportate le modifiche richieste (di nuovo nel tuo ramo), tutto ciò che devi fare è confermare e inviare le modifiche. Il PR si aggiornerà automaticamente con le nuove modifiche.
Prometto che cercherò di rivedere e unire il prima possibile, ma lo faccio nel mio tempo libero, quindi qualche giorno di ritardo è inevitabile.
- Torna tra un po' per verificare la presenza della tua richiesta di pull unita.
- Dovresti ricevere un'e-mail da GitHub quando le modifiche sono state approvate o se sono richieste ulteriori modifiche. E quando il PR sarà finalmente fuso con il master e la tua carta sarà stata aggiunta.
- Puoi anche imparare come contribuire da questa serie gratuita: Come contribuire a un progetto Open Source su GitHub
- Se hai trovato questo progetto utile, assegnagli ⭐ star ⭐ nella parte superiore della pagina e Twitta** al riguardo per contribuire a spargere la voce ![Tweet](https:/ /img.shields.io/twitter/url/http/shields.io.svg?style=social)
- Puoi seguirmi ed entrare in contatto su Twitter o [utilizzando una qualsiasi di queste altre opzioni](https://syknapse.github. io/Syk-Houdeib/#contact 'La mia sezione contatti | Portfolio')
- Questo è un progetto open source, quindi oltre a contribuire con la tua carta, sei invitato a contribuire a correggere bug, miglioramenti o nuove funzionalità. Apri un problema o invia una nuova [pull request](https://help.github.com /articles/creating-a-pull-request-from-a-fork/ 'Creazione di una richiesta pull da un fork | Guida GitHub')
- Per contribuire a migliorare la nostra community, dai un'occhiata alla scheda GitHub Discussions situata accanto a Pull Requests. Quest'area è un luogo in cui presentarti, approfondire discussioni sull'Open Source e comunicare con i manutentori del progetto. Ci aiuterai a sviluppare questa funzionalità e a migliorare la nostra community?
- Grazie per aver contribuito a questo progetto. Ora puoi andare avanti e provare a contribuire ad altri progetti; cerca l'etichetta per opzioni di contributo adatte ai principianti.
- Cerco anche collaboratori che mi diano una mano nella revisione e nella fusione dei PR. Se desideri fare pratica Git più avanzata, inviami un DM su Twitter e leggi la guida del manutentore.
Questo progetto è fortemente influenzato dal fantastico progetto first-contributions di Roshan Jossey con il suo eccellente tutorial.
È inoltre particolarmente ispirato dalla grande community attorno a #GoogleUdacityScholars La borsa di studio Google Challenge: Front-End Web Dev, classe 2017 Europa.