Update Regole d oro

omar 2024-07-09 09:45:47 +00:00
parent 0871d19dbe
commit 5144b5b0df

@ -31,13 +31,29 @@ Se contribuisci ampiamente ed in modo continuativo o vuoi testare il codice, sca
In generale il processo per contribuire al repo si riassume in questi passaggi:
* All'interno del tuo fork **\<user\>/bglug.it**, creare un branch cliccando la scheda Rami(Branch) che trovi appena sopra l'elenco dei file.
* Lavorare dentro il branch: nel nostro caso modificare un post, creare cartella e file, caricare documenti/immagini, etc.
* Fare i commit
* Eseguire fetch e controllare se l'upstream è cambiato e nel caso fare il [rebase](#fare-il-rebase).
* Fare pull-request e una volta accettata, le modifiche saranno inserite in upstream, probabilmente in una commit sola.
* A quel punto il branch non serve più e lo puoi eliminare
* Ogni branch deve contenere un numero limitato di modifiche (diciamo 5 post) e quindi se necessisario crea più di un branch.
### Se lavori ONLINE
NB:
Quando crei un nuovo branch è consigliato farlo partendo dall'ultima commit upstream. In questo modo si evita di dover risolvere conflitti più tardi quando si vorrà esegi una PR. Se il fork è appena stato fatto non serve fare nulla, altrimenti sarà necessario eseguire un [rebase del ramo](Operazioni-fondamentali#avanzamento-di-un-branch-da-eseguire-prima-di-un-a-pr-git-pull---rebase). È possibile fare il rebase del branch dopo aver inviato una nuova PR; apri la PR che hai inviato da qui [Pull Requests](https://git.libreschool.org/BgLUG/bglug.it/pulls), se è necessario eseguire un rebase troverai un pulsante in fondo alla pagina.
* All'interno del tuo fork **\<user\>/bglug.it**, crea un 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](https://git.libreschool.org/BgLUG/bglug.it/pulls) 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 ONLINE
* Esegui il **fetch** e fai avanzare main e rami e, se necessario, esegui **reset, pull o rebase**. [Leggi qui](Operazioni-fondamentali)
* Partendo dal main crea un [Branch: comandi utili](Branch).
* 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](#NB). Questo passaggio non è obbligatorio potendolo fare dall'applicazione web di 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](#se-lavori-online).
### NB:
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](Operazioni-fondamentali#avanzamento-di-un-branch-da-eseguire-prima-di-un-a-pr-git-pull---rebase).
È possibile fare il rebase del branch anche dopo aver inviato una nuova PR; apri la PR che hai inviato da qui [Pull Requests](https://git.libreschool.org/BgLUG/bglug.it/pulls), se è necessario eseguire un rebase troverai l'apposito pulsante in fondo alla pagina.