Source code management/it

Il nostro principale strumento di gestione del codice sorgente distribuito è Git. Questo articolo spiega come usarlo e quali sono le regole generali applicabili per FreeCAD.

Ci sono anche molti buoni clienti grafici per git, come git-cola, che facilitano l'intero processo di gestione del repositorio git

Accesso
Tutti possono accedere e ottenere una copia del codice sorgente di FreeCAD, ma solo i gestori del progetto di FreeCAD hanno l'accesso in scrittura. È possibile ottenere una copia del codice, studiarlo e modificarlo come si vuole, ma se si apporta una modifica che si desidera vedere inclusa nel codice sorgente ufficiale, è necessario fare una richiesta di pull nella sezione pull requests del forum di FreeCAD.

La procedura seguente mostra come ottenere una copia del codice sorgente di FreeCAD, da uno dei nostri due repository ufficiali:

Via Github
Un modo semplice per iniziare a lavorare con il codice sorgente di FreeCAD è quello di utilizzare github. Anche se il repository Git ufficiale di FreeCAD è attualmente ospitato su Sourceforge (vedere sotto), su questo repository github il nostro ramo master è speculare e può essere facilmente clonato e utilizzato: https://github.com/FreeCAD/FreeCAD_sf_master

Si può iniziare semplicemente utilizzando il pulsante "fork" (biforcazione)in cima alla pagina di cui sopra. Questo crea una copia del repository di FreeCAD sul proprio account github. La procedura generale è la seguente:
 * 1) Creare un proprio account github
 * 2) Andare in https://github.com/FreeCAD/FreeCAD_sf_master
 * 3) Premere il pulsante "fork"
 * 4) Clonare sulla propria macchina la biforcazione di FreeCAD appena creata
 * 5) Fare le modifiche al codice
 * 6) Creare un nuovo ramo
 * 7) Fare il Checkout a questo nuovo ramo
 * 8) Fare il Commit delle proprie modifiche a tale nuovo ramo
 * 9) Trasferire tale nuovo ramo nel proprio repo github

È anche possibile iniziare, senza utilizzare il pulsante "fork":
 * 1) Clonare il codice di FreeCAD con git
 * 2) Modificare il codice
 * 3) Creare unnuovo ramo
 * 4) Eseguire il Checkout a tale nuovo ramo
 * 5) Eseguire il Commit delle modifiche a tale nuovo ramo
 * 6) Creare un prorpio account a un server git pubblico (github, gitorious, sourceforge o qualsiasi altro)
 * 7) Trasferire il proprio ramo su tale server

Nota importante: Siccome il nostro repository GitHub è solo un mirror (uno specchio), non lo guardiamo sempre con attenzione. Pertanto, si prega di non utilizzarlo per le richieste di pull. Se si dispone di codice che si desidera vedere fuso nel codice sorgente di FreeCAD, si prega di inviare invece una nota nella sezione pull requests del forum di FreeCAD.

Via Sourceforge
Per accedere a un repositorio Git su sf.net, configurare il proprio client Git in questo modo:

git://git.code.sf.net/p/free-cad/code (permesso di solo lettura) ssh://USERNAME@git.code.sf.net/p/free-cad/code (permesso di lettura e scrittura)

Regole di accesso
Daremo a chiunque sia interessato a partecipare l'accesso in scrittura al repository git con la condizione di stare lontani dal ramo principale (consiglio).

Autenticazione
L'accesso in sola lettura non richiede una password.

L'accesso in lettura e scrittura richiede la password SSH o la chiave SSH per autorizzare l'accesso. Per poter eseguire le operazioni di scrittura, l'amministratore del progetto deve aver concesso l'accesso in scrittura al repository.

Nota: In tutti gli esempi riportati in seguito, "USERNAME" rappresenta il proprio account in SourceForge.net.

Come clonare il repository
Si può clonare facilmente il repository remoto e iniziare a lavorare con: git clone ssh://USERNAME@git.code.sf.net/p/free-cad/code REPONAME cd REPONAME La prima volta che si tenta il collegamento all'host di free-cad.git.sourceforge.net, si dovrebbe ricevere un messaggio simile al seguente: The authenticity of host 'git.code.sf.net (216.34.181.91)' can't be established. RSA key fingerprint is 86:7b:1b:12:85:35:8a:b7:98:b6:d2:97:5e:96:58:1d. Are you sure you want to continue connecting (yes/no)? Prima di digitare 'yes' per accettare la firma digitale di accoglienza, accertarsi che la firma digitale per l'host sia corretta. È possibile trovare un elenco di chiavi di host SSH nella lista delle chiavi SSH, di firme host. Se si riceve un messaggio di avviso di chiave host, si prega di contattare il team di SourceForge.net.

Impostare il proprio nome utente in Git
Gli utenti devono connettersi al proprio repository del progetto utilizzando il proprio nome utente di SourceForge.net. Se il nome utente non è già impostato a livello globale, è possibile impostarlo a livello locale per il repository Git attuale in questo modo: git config user.name "YOUR NAME" git config user.email "USERNAME@users.sourceforge.net" È ora possibile utilizzare una combinazione di comandi "git add" e "git commit" per creare uno o più commit nel proprio repository locale.

Da repositori alternativi
La bellezza di git è che tutti possono clonare un progetto, e iniziare a modificare il suo codice. Diversi collaboratori frequenti del progetto di FreeCAD hanno un proprio repository git, dove costruiscono il loro lavoro prima che sia pronto per essere incluso nel codice sorgente ufficiale, o dove sperimentano semplicemente delle nuove idee. In alcuni casi, si potrebbe desiderare di clonare il codice FreeCAD da uno di loro, invece del repository ufficiale, per beneficiare dei cambiamenti fatti da questi utenti.

Attenzione, però, che questo è a proprio rischio, in quanto solo i due repository ufficiali di cui sopra contengono il codice pulito e il funzionamento è garantito.

È anche possibile collegare diversi repository remoti a un medesimo codice git locale utilizzando il comando "git remote". Questo è utile per mantenere la sincronia con il ramo principale del codice, ma tenere d'occhio il lavoro degli altri sviluppatori.

Sviluppo
Prima di tutto non sviluppare mai sul ramo master! Creare sempre un ramo locale di sviluppo. Per imparare come farlo, consultare questa pagina.

Ramificazioni
Una caratteristica importante di Git è che è estremamente facile lavorare con i rami e poi fonderli. Le procedure ottimali raccomandano di creare un nuovo ramo ogni volta che si desidera lavorare su una nuova funzionalità. Per creare un ramo fare in questo modo: git branch myNewBranch git checkout myNewBranch oppure, eseguire entrambe le operazioni in una sola: git checkout -b myNewBranch è sempre possibile verificare in quale ramo si stà operando con: git branch

Invio
Dopo aver prodotto un po' di lavoro, si può inviarlo con: git commit -a A differenza di SVN, è necessario indicare specificare quali file sono da inviare (o tutti con l'opzione -a). Il proprio editor di testo si apre per consentire di scrivere un messaggio di commit.

Pubblicare il proprio lavoro nel repository di sourceforge
Dopo aver fatto un pò di lavoro nel ramo locale e averlo inviato (questo inviato significa a livello locale) si può inviare il proprio repository sul server. Questa azione apre il ramo al pubblico e permette agli sviluppatori principali di rivederlo e di integrarlo nel ramo master. git push my-branch

Pubblicazione su un altro repositorio
Git permette anche di unire rami da repository diversi. Se non si dispone di accesso in scrittura al repository Git di FreeCAD ospitato da sourceforge, è possibile impostare un account in qualsiasi altro host Git libero come github o gitorious e comunicare agli altri dove sono disponibili le modifiche apportate.

Scrivere buoni messaggi di commit
Si dovrebbe cercare di lavorare in piccole parti. Se non è possibile riassumere le proprie modifiche in una sola frase, è probabile che sia passato troppo tempo da quando si è fatto l'ultimo commit. Inoltre è importante che le descrizioni del lavoro siano dettagliate e utili. Per i messaggi di commit, FreeCAD adotta un formato menzionato nel libro Pro Git.

Breve riepilogo delle modifiche (circa 50 caratteri) Se è necessario, testo esplicativo più dettagliato. Utilizzare circa 72 caratteri. In alcuni contesti, la prima riga è trattata come oggetto di un messaggio e il resto del testo come il corpo. E'fondamentale lasciare una riga vuota per separare il riassunto dal corpo (a meno che non si ometta per intero il corpo); se le due parti sono unite gli strumenti come rebase possono confondersi. Ulteriori paragrafi vanno dopo una riga vuota. - Anche gli elenchi puntati sono validi - Tipicamente per le voci dell'elenco si usa un trattino o un asterisco preceduto da uno spazio bianco, e sono intervallate da una riga vuota, ma queste convenzioni possono variare

Se si sta facendo diversi lavori connessi, qui viene suggerito che si dovrebbero fare altrettanti invii, grandi o piccoli, secondo come è necessario e descriverli con brevi messaggi di commit. Quando si desidera unirli, fare un log master git..BRANCH e utilizzare il risultato come base per il messaggio di commit. Poi, quando si uniscono al master usare l'opzione --squash e inviarlo con il messaggio di commit. Questo permette di essere molto liberi con il commit e contribuisce a fornire un buon livello di dettagli nei messaggi di commit senza tante descrizioni distinte.

Ulteriori letture

 * Git for the lazy
 * Git pro libro on-line