You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Questo è un tutorial con lo scopo di aiutare i contributori alle prime armi a partecipare a un progetto semplice e facile.
Obiettivi
Dare un contributo a un progetto open source.
Prendere dimestichezza con GitHub.
A chi è rivolto?
Ai principianti. Se sai come scrivere e modificare un tag di ancoraggio <a href="" target=""> </a>, dovresti essere in grado di farcela.
Per quelle persone con un po' più di esperienza ma che vogliono dare il loro primo contributo all'open source oppure fare più contribuzioni per ottenere sempre più esperienza e sicurezza.
Perché devo farlo?
Qualsiasi sviluppatore web, che si tratti di un aspirante o che sia già un esperto, sa che deve utilizzare il controllo della versione di Git. GitHub è il servizio di hosting Git più popolare utilizzato da tutti. È anche il cuore della comunità Open Source. Abituarsi a usare GitHub è un'abilità essenziale. Contribuire a un progetto aumenta la sicurezza in te stesso e ti dà qualcosa da mostrare sul tuo profilo GitHub.
Se sei un nuovo sviluppatore e ti stai chiedendo se devi imparare Git e GitHub, ecco la risposta: Avresti dovuto imparare Git ieri stesso.
A Che cosa andrò a contribuire?
Contribuirai con una card come questa alla pagina web del progetto. Includerà il tuo nome, il tuo Twitter handle , una breve descrizione e 3 collegamenti a risorse utili per gli sviluppatori web.
Farai una copia del modello di questa card all'interno del file HTML e lo personalizzerai con le tue informazioni.
In alternativa, se hai dimestichezza con Git dalla riga di comando, puoi farlo (ecco first-contributions, un progetto simile che può servire da guida per i comandi necessario).
Altrimenti se usi 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 per seguire questa esercitazione è utilizzare GitHub Desktop.
Ora che sei pronto, iniziamo con l'attività di contribuzione al progetto.
Contribuisci
Diventa un collaboratore open source in 10 semplici passaggi.
_ Tempo stimato: meno di 30 minuti_.
Passaggio 1: eseguire il fork di questo repository
L'obiettivo consiste nel fare una copia di questo progetto e inserirlo nel tuo account.
Un repository (repo) è il modo in cui un progetto viene chiamato su GitHub e un fork corrisponde a una copia.
Un progetto forked avrà il simbolo del fork sulla sinistra.
Il tuo fork avrà il tuo nome utente GitHub.
Questo richiederà un po' di tempo mentre il progetto viene copiato sul tuo disco rigido. Vi consiglio di mantenere il percorso predefinito che di solito è ..\Documenti\GitHub.
Ora hai una copia locale del progetto.
Passaggio 3: Crea un nuovo branch
Dopo aver clonato il repository e averlo aperto sul desktop di GitHub, è il momento di creare un nuovo branch.
Un branch è un modo per mantenere separate le modifiche dalla parte principale del progetto chiamata "Master". Ad esempio, se le cose vanno male e non sei soddisfatto delle modifiche, puoi semplicemente eliminare il branch e il progetto principale non sarà compromesso.
Fai click su Current branch
e successivamente fai click su New
dai un nome al tuo branch
Fai click su Create branch
Puoi nominarlo come preferisci, ma dato che si tratta di un branch per aggiungere una card con il tuo nome al progetto, chiamarla "card-tuo-nome" è una buona pratica perché mantiene chiara l'intenzione di questo branch.
Pubblica il tuo nuovo branch su Github
Ora hai creato un nuovo branch separato dal master.
Per i passaggi successivi, assicurati di lavorare in questo branch. Vedrai il nome del branch in cui ti trovi in alto al centro dell'app desktop GitHub dove dice Current branch.
NON lavorare sul master branch
Passaggio 4: Apri il file index.html
Ora dobbiamo aprire il file che stiamo per modificare con un qualsiasi editor di codice che ti consenta di modificare il file index.html.
Trova la cartella del progetto sul tuo computer. Se hai mantenuto l'impostazione predefinita, dovrebbe essere qualcosa come tuo-computer> Documenti> GitHub> Contribute-To-This-Project
Il file index.html è nella cartellaContribute-To-This-Project.
Apri il tuo editor di codice (Sublime, VS Code, Atom..etc) e usa il comando Apri file e individua il file index.html nella directory principale del progetto
In alternativa è possibile individuare il file sul disco rigido, fai click con il tasto destro e apri con l'editor
Ora hai il file che stai per modificare aperto nel tuo editor e sei pronto per iniziare a modificarlo.
Passaggio 5: copia il modello della card
Faremo una copia del modello della card per iniziare a lavorarci
Scorri verso il basso verso la fine del file dove troverai la sezione etichettata == TEMPLATE ==
Copia tutto all'interno come mostrato nel quadrato rosso nell'immagine, dal commento Contributor card START al commentoContributor card END
Incolla tutto direttamente sopra il commento che indica dove posizionare il tutto
Assicurati che ci sia una sola linea di spazio tra l'inizio e la fine dell'ultima card. È buona norma mantenere il nostro codice il più chiaro possibile
Assicurati che il rientro sia corretto e corrisponda al modello
Questa ora è la tua card pronta per essere personalizzata e modificata.
Passaggio 6: applicare le modifiche
Ora inizieremo a modificare l'html, cambiando i campi personalizzabili nella nostra card.
Sostituisci 'Name' con il tuo nome
Nota: non cambiare class="name"
Inserisci l'URL del tuo account Twitter href ="Inserisci l'URL qui"
Digita il Nickname nel campo di testo
Se preferisci utilizzare un metodo di contatto diverso da Twitter, dovrai sostituire l'icona di Twitter <i class =" fa fa-twitter "> </i> andando su Font Awesome Icons cercando l'icona giusta e sostituendo solo la parte fa-twitter con la nuova icona comefa-facebook per esempio. Quindi seguire gli stessi passaggi descritti in precedenza.
Raccontaci qualcosa di te
Scrivi qualcosa di breve e dolce. Dovrebbe essere qualcosa di simile a un tweet piuttosto che un post sul blog
Condividi con la community 3 collegamenti a risorse utili allo sviluppo web
Può trattarsi di qualsiasi cosa, un video, un discorso, un podcast, un articolo, un riferimento o uno strumento
Se sei un principiante, non lasciarti intimidire da questo, condividi ciò che sai anche se pensi che sia troppo basilare. Sarai sorpreso di quante persone ne trarranno beneficio
Link: inserisci il link href =" qui " sostituendo il #
Titolo: Scrivi una breve descrizione title =" qui "
Nome: scrivi il nome della risorsa nel campo di testo > qui </a>
Assicurati di aver **salvato tutte le modifiche**.
**Prova le tue modifiche**. QUESTO È IMPORTANTE! Apri il file html nel tuo browser (facendo doppio clic su di esso ad esempio) e guarda come apparirà la tua card sul sito. Assicurati che l'intera pagina sembri sempre la stessa e assicurati che non ci siano errori. Fai clic sui tuoi collegamenti(link) e assicurati che funzionino. Apri la console (Ctrl + Maiusc + J (Windows / Linux) o Cmd + Opt + J (Mac)) e verifica che non vi siano messaggi di errore.
Fantastico, hai finito di modificare il tuo codice! I passaggi successivi ti aiuteranno a inviare le modifiche a GitHub che le inoltrerà come richiesta per essere unite al progetto principale.
Passaggio 7: eseguire il commit delle modifiche
Torna all'app desktop GitHub.
Le modifiche saranno state aggiunte automaticamente all'area di gestione temporanea.
Ciò significa che Git ha registrato tutte le modifiche **salvate**.
Potrai vederlo nell'app. Tutto ciò che hai aggiunto al file sarà in verde e le eliminazioni verranno visualizzate in rosso.
Il prossimo passo è chiamato Commit
Ciò significa approssimativamente "confermare le modifiche"
Ecco come dovrebbe apparire l'intestazione di GitHub desktop
Nota il simbolo della fork accanto al nome del progetto in "Current repository"
Il tuo Current branch avrà il nome che gli hai dato nel passaggio 3
Per eseguire il Commit devi compilare il campo Summary
Questo è il messaggio di commit che ti spiega cosa hai cambiato
In questo caso "Added my card information" sarebbe un messaggio corretto come spiegazione dei cambiamenti apportati
Opzionalmente è possibile aggiungere più dettagli alla Descrizione
fai Click sul pulsante Commit . Il dovrà apparire più o meno così: Commit in" your-branch-name "
![Write commit message and commit](/readme-only/commit-message.PNG "Scrivi un breve messaggio di commit nell'input "summary" e fai clic su "commit"")
Passaggio 8: invia(operazione di Push) le modifiche(changes) a GitHub
Le modifiche sono ora salvate o confermate(committed). Ma vengono salvate solo localmente, cioè sul tuo computer.
La sincronizzazione delle modifiche locali con il repository su Github si chiama Push. Stai "inviando" le modifiche dal tuo repository locale al repository remoto su Github.
fai click su Push button
![Push to GitHub](/readme-only/push.PNG "Invia le tue modifiche a GitHub, fai clic sul pulsante "Push"")
Dopo alcuni secondi l'operazione dovrebbere essere completata e ora hai esattamente la stessa copia di questo branch sul tuo computer e su GitHub.
Passaggio 9: inviare una PR (Pull Request)
Questo è il momento che stavate aspettando; inviare una Pull Request (PR).
Finora tutto il lavoro che hai fatto è stato sul fork del progetto, che come ricordi risiede sul tuo account personale di GitHub.
Ora è il momento di inviare le modifiche al progetto principale per unirle con esso.
Questa operazione si chiama Pull Request perché stai chiedendo al manutentore del progetto originale di effettuare ò'operazione di "pull" direttamente nel loro progetto.
Vai alla pagina principale di ** your fork ** su GitHub (avrà l'icona della fork e il tuo nome utente in alto).
Verso la parte superiore del repository verrà visualizzato un messaggio di pull request evidenziato con un pulsante verde.
fai click su Compare and pull request
Ecco come appare la pagina Open a pull request .
RICORDA che stai provando a fondere il tuo branch con il progetto originale, non con il branch "Master" sul tuo fork.
L'immagine qui sotto ti dà un'idea di come dovrebbe apparire l'intestazione della tua richiesta pull.
A sinistra è situato il progetto originale, seguito dal branch principale. Sulla destra c'è il tuo fork e branch che hai creato.
Crea una pull request:
Scrivi un titolo
Aggiungi informazioni opzionali nella descrizione
Fai Click su Create pull request
Non lasciarti stupire da tutte le opzioni. Per ora devi solo eseguire questi tre passaggi.
Lascia selezionata l'opzione "Consenti modifiche dai manutentori".
Ora, una _Pull Request_ verrà inviata al manutentore del progetto. Non appena esaminato e accettato, le modifiche verranno visualizzate nella [pagina web del progetto](https://syknapse.github.io/Contribute-To-This-Project 'Contribuisci a questo progetto pagina Web').
Passaggio 10: Festeggiare!
Questo è tutto. ce l'hai fatta! Ora hai contribuito all'open source su GitHub.
Le tue modifiche non saranno immediatamente visibili; per prima cosa devono essere riviste, accettate e unite dal manutentore del progetto. Una volta unite, la tua card dovrebbe essere visibile e visibile sulla pagina.
È normale per un revisore chiedere modifiche su un PR. Pensalo come una buona pratica se ti succede. Tieni d'occhio commenti e modifiche richieste. Una volta apportate le modifiche richieste (di nuovo nel tuo branch) tutto ciò che devi fare è impegnarti e inviare le modifiche. Il PR si aggiornerà automaticamente con le nuove modifiche.
Prometto che proverò a rivedere e unire il prima possibile, ma lo faccio nel tempo libero, quindi è inevitabile un ritardo di alcuni giorni.
Prossimi passi
Torna tra un po' per verificare la tua richiesta pull unita.
Dovresti ricevere un'email da GitHub quando le modifiche sono state approvate o se sono richieste ulteriori modifiche. E quando il PR viene finalmente unito al master e la tua card è stata aggiunta.
Se hai trovato questo progetto utile ti preghiamo di dargli una: ⭐ star ⭐ nella parte superiore della pagina e un ** Tweet **per aiutare a spargere la voce**
Questo è un progetto open source, quindi oltre a contribuire con la tua card sei il benvenuto per aiutarci a correggere bug, miglioramenti o nuove funzionalità. Apri un numero o invia una nuova richiesta pull
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 intuitive per i principianti.
Cerco anche collaboratori che mi diano una mano nella revisione e nella fusione di PR. Se desideri avere una pratica Git più avanzata, inviami un DM su Twitter.
Ringraziamenti
Questo progetto è fortemente influenzato dal progetto Roshan Jossey di grande primo contributo con il suo eccellente tutorial.
È particolarmente ispirato dalla grande comunità intorno a #GoogleUdacityScholars La borsa di studio Google Challenge: Front-End Web Dev, classe 2017 Europa.
per opzioni di contributo intuitive per i principianti.