Regole d'oro :)
Crea o richiedi un account ed accedi. Dalla pagina del repository originale BgLUG/bglug.it eseguire il Fork cliccando l'icona in alto a destra. Per ogni repo puoi eseguire un solo fork.
Via web o in locale?
Ci sono due alternative per contribuire:
- utilizzare l'applicazione online Gitea, usando il browser
- lavorare in locale, scaricando tutto il codice e utilizzando il terminale-editor di testo-client GIT che si preferisce
Ovviamente la seconda alternativa è la più completa e versatile, permettendoti di poter scegliere tra molte alternative software e/o di utilizzare applicazioni che già conosci.
Vediamo pro e contro del solo utilizzo dell'applicazione online:
- PRO
- Comoda per piccole modifiche
- Utile se non stai utilizzando il tuo PC o non vuoi installarci nulla
- Limitato alle operazioni base offerte da git e quindi facile da usare
- Gestisce l'interazione con gli utenti proponendo: issue, commentando le pull request (PR), collaborando alla wiki, etc.
- CONTRO
- Non è comoda per l'organizzazione dei file come: cancellazione, spostamento, etc.
- L'interfaccia web non è personalizzabile: o vedi l'elenco dei file o il contenuto di uno solo, etc.
- Ogni file modificato genera un commit
- Puoi operare solo su un file alla volta a meno di aprire più schede nel browser
- Non puoi eseguire comandi git e quindi molte operazioni che questo VCS permette
- Non è così veloce passare tra le varie versioni o rami del codice
- Non puoi testare il codice
Se contribuisci ampiamente ed in modo continuativo o vuoi testare il codice, scarica tutto il necessario in locale e, dove aver sincronizzato, utilizza l'applicazione web per eseguire pull request ed interagire con il team.
Operazioni richieste per contribuire
In generale il processo per contribuire al repo si riassume in questi passaggi:
Se lavori dal BROWSER
- All'interno del tuo fork <user>/bglug.it, crea un ramo (branch), cliccando la scheda Rami(Branch) che trovi appena sopra l'elenco dei file.
- Lavora dentro il branch: modifica un post, crea cartelle e file, carica documenti/immagini, etc.
- Compila con una una descrizione e salva per eseguire il commit. Esegui un numero limitato di commit e quindi invia un PR. È meglio se le PR riguardano argomenti omogenei: correzioni di qualche evento, allegati di un post, modifiche ai post di un periodo preciso. Puoi creare contemporaneamente più rami e più PR, quindi spezzetta il lavoro in tanti piccoli contributi distinti.
- Fai una
Nuova Pull Request
. Troverai un link sopra il codice o un pulsante nella scheda dei Rami(Branch). Compila con una descrizione e invia. - Vai nella scheda Pull Requests dell'upstream e apri la tua PR.
- In basso controlla se compare il pulsante che ti propone di aggiornare il tuo ramo con un merge/rebase. Scegli rebase ed eseguilo. È indispensabile al merge con l'upstream.
- Aspetta che qualcuno del team commenti, in genere per chiedere correzioni. Quando tutto è corretto e almeno uno del team ha approvato mettendo una spunta verde, puoi eseguire il merge.
- A questo punto il tuo branch non serve più e lo puoi eliminare. Puoi farlo contemporaneamente al merge o in seguito.
Se lavori da LOCALE
- Esegui il fetch e fai avanzare main e rami e, se necessario, esegui reset, pull o rebase. Leggi le procedure fondamentali
- Partendo dal main crea un branch. Vedi i comandi base.
- Lavora dentro il branch: modifica un post, crea cartelle e file, carica documenti/immagini, etc.
- Esegui stage e commit.
- Esegui fetch e controlla se l'upstream è cambiato e nel caso fai il rebase. Questo passaggio non è obbligatorio potendolo fare online nell'istanza Gitea.
- Dal tuo fork, fai una
Nuova Pull Request
. Troverai un link sopra il codice o un pulsante nella scheda dei Rami(Branch). Compila con una descrizione e invia. - Concludi come indica sopra.
Nota bene
Quando crei un nuovo branch è consigliato farlo partendo dall'ultima commit upstream. In questo modo si evita di dover risolvere conflitti, per esempio, quando più tardi si vorrà eseguire una PR. Se il fork è appena stato fatto non serve fare nulla, altrimenti sarà necessario eseguire un rebase del ramo. È possibile fare il rebase del branch anche dopo aver inviato una nuova PR; apri la PR che hai inviato da qui Pull Requests, se è necessario eseguire un rebase troverai l'apposito pulsante in fondo alla pagina.
Come contribuire usando Gitea
Comandi hugo e struttura del sito
- Contribuire dal BROWSER
- Contribuire da LOCALE
- I'm a lazy boy
- Cartella content e permalink
- Front matter
- Note sull'utilizzo di media
- Inviare una PR
- Aggiungere warning in homepage
Comandi GIT
Guide online