Questo tutorial su GitHub si basa amorevolmente su DjangoGirls How To Contribute Tutorial che è disponibile sotto una licenza Creative Commons Attribuzione-Condividi allo stesso modo 4.0.
Per questa esercitazione, utilizzeremo il repository Briefcase come base. Briefcase come base per i collegamenti e i riferimenti. per i collegamenti e i riferimenti.
Operazioni preliminari e prerequisiti
Per contribuire a BeeWare, è necessario quanto segue per iniziare:
- un account GitHub
- nel caso di modifiche complesse, familiarità con Git command line di comando Git o familiarità con un'applicazione con un'applicazione (Windows e Mac) per inviare a GitHub le modifiche apportate sul computer. le modifiche apportate sul computer a GitHub.
Aprire il repository
Per prima cosa, creare un fork del repository Briefcase sul proprio account GitHub personale:
Modifica della documentazione
Modifiche semplici
Per semplici modifiche, come la correzione di errori di battitura, è possibile utilizzare l'editor online di GitHub. per l'editor:
- Aprire la pagina del fork locale su GitHub,
- andare al file README.rst in qualsiasi capitolo,
- premere l'icona Modifica (penna)
e si può modificare il capitolo direttamente su github.com.
La sintassi RST viene utilizzata per modificare le singole pagine della documentazione.
Nota
La schermata di cui sopra potrebbe non riflettere ciò che è attualmente presente nel repository GitHub. Il repository live cambia di tanto in tanto. Tuttavia, il processo di invio delle richieste di pull rimane lo stesso.
Salvare le modifiche e creare una richiesta di pull come spiegato di seguito.
Nuovo codice e modifiche complesse
Per aggiungere nuovo codice, estendere le classi o apportare modifiche complesse, occorre una copia del codice sul computer locale.
Utilizzare l'applicazione GitHub per il proprio sistema operativo (menzionata in precedenza) o il comando
la riga di comando git per ottenere il repository localmente. L'indirizzo del repository
dalla pagina iniziale del proprio fork del repository GitHub:
git clone git@github.com:yourusername/briefcase.git
Quindi, creare un ramo in cui inserire le nuove modifiche. È utile chiamare il ramo con un nome che abbia a che fare con le modifiche che si intende apportare.
git checkout -b update_documentation
Apportare eventuali modifiche al codice e assicurarsi che siano testate e salvate localmente.
Quindi eseguire il commit delle modifiche usando git e inviare le modifiche al repository remoto di
GitHub.
Esempio:
$ git status
Sul ramo update_documentation
File non tracciati:
(usare "git add <file>..." per includerli in ciò che verrà impegnato)
README.rst
git add README.rst
$ git commit -m "Aggiornare la documentazione README.rst per Briefcase"
[update_documentation fe36152] Aggiunto lo screenshot di gitbook
1 file modificato, 0 inserimenti(+), 0 eliminazioni(-)
modalità di creazione 100644 README.rst
$ git push
Conteggio degli oggetti: 11, fatto.
Compressione delta utilizzando fino a 8 thread.
Compressione degli oggetti: 100% (5/5), fatto.
Scrittura degli oggetti: 100% (5/5), 266,37 KiB | 0 byte/s, fatto.
Totale 5 (delta 1), riutilizzato 0 (delta 0)
A git@github.com:yourusername/briefcase.git
b37ca59..fe36152 update_documentation -> update_documentation
Fare una richiesta di pull
Dopo aver terminato le modifiche, è necessario creare [una richiesta di pull una richiesta di pull su GitHub. BeeWare riceverà una notifica della richiesta di pull, esaminerà le modifiche modifiche, suggerirà eventuali correzioni se necessarie e quindi tira le modifiche alla versione principale. alla versione principale.
Nel proprio repository su GitHub premere Compare & pull request.
Compilare le informazioni sul perché si sta apportando questa modifica. Il revisore può vedere i dettagli della modifica vera e propria, quindi non è necessario ripetere il contenuto della modifica. contenuto della modifica.
Quindi premere Crea richiesta di pull.
Le e-mail di GitHub vi avviseranno del processo di follow-up.