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. Prima di lavorare con il codice sorgente di FreeCAD, si consiglia vivamente di imparare come funziona Git (per Git ci sono un sacco di tutorial e di documentazione disponibile su Internet)
Ci sono anche molti buoni clienti grafici per git, come git-cola, che facilitano l'intero processo di gestione del repositorio git
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.
In tutti gli esempi sottostanti, "GITHUB_USERNAME" rappresenta il proprio account GitHub.
Un modo semplice per iniziare a lavorare con il codice sorgente di FreeCAD è quello di utilizzare il repositorio ufficiale su https://github.com/FreeCAD/FreeCAD
Gli utenti devono connettersi al proprio repository del progetto utilizzando il proprio nome utente di GitHub. 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 "GITHUB_USERNAME@users.noreply.github.com"
È ora possibile utilizzare una combinazione di comandi git add e git commit per creare uno o più commit nel proprio repository locale.
Please read some background to help you understand better the difference between what origin and upstream mean in the context of git. This section explains how to set the correct upstream and origin remote git repos. Essentially:
This is important to understand because if you git clone directly from upstream then confusingly, your origin will be listed as https://github.com/FreeCAD/FreeCAD.git So, based on the above, there are 2 main ways to setup your git environment:
We recommend the 1st method for the reason mentioned above.
You will need to re-configure 'remote upstream' as mentioned above in "A note about Remotes"
This method is the recommended way since it takes less steps. You will essentially fork the FreeCAD repo on your own GitHub account and then clone said GitHub fork locally. Then you will set your upstream repo in git. The procedure is as follows:
git clone https://github.com/GITHUB_USERNAME/FreeCAD.git
[foo@bar FreeCAD]$ git remote -v
originhttps://github.com/GITHUB_USERNAME/FreeCAD.git (fetch)
originhttps://github.com/GITHUB_USERNAME/FreeCAD.git (push)[foo@bar FreeCAD]$ git remote add upstream https://github.com/FreeCAD/FreeCAD.git
[foo@bar FreeCAD]$ git remote -v
originhttps://github.com/GITHUB_USERNAME/FreeCAD.git (fetch)
originhttps://github.com/GITHUB_USERNAME/FreeCAD.git (push)
upstreamhttps://github.com/FreeCAD/FreeCAD.git (fetch)
upstreamhttps://github.com/FreeCAD/FreeCAD.git (push)È anche possibile iniziare, senza utilizzare il pulsante "fork":
git clone https://github.com/FreeCAD/FreeCAD.git
Prima di tutto non sviluppare mai sul ramo master! Creare sempre un ramo locale di sviluppo. Per imparare come farlo, consultare Git-Branching-Basic-Branching-and-Merging chapter on git-scm.
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
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.
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 <REMOTENAME> <BRANCHNAME> git push origin my-branch
For further info on this subject please read https://help.github.com/articles/pushing-to-a-remote/
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.
Git has the capability to merge patches/diffs. To read more about this read the following reference: https://www.drupal.org/node/1399218
Regular GitHub page: https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621
'Diffed' GitHub page: https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.diff
'Patched' GitHub page: https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.patch
curl https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.patch | git apply -
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 il repository ufficiale di cui sopra contiene 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.