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. 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

Accesso al codice sorgente
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.

Repositorio ufficiale 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

Impostare il proprio nome utente in Git
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.

A note about Remotes
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: 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.
 *   = Your fork of the FreeCAD git repo AKA https://github.com/GITHUB_USERNAME/FreeCAD.git
 *   = The official FreeCAD git repo AKA https://github.com/FreeCAD/FreeCAD.git
 * This is important to understand because if you  directly from   then confusingly, your origin will be listed as https://github.com/FreeCAD/FreeCAD.git BTW, if you do this accidentally you can use the   command to remedy the situation.
 * 1st Method: Fork on GitHub and clone your fork locally
 * 2nd Method: Clone FreeCAD official directly to your local machine

1st Method: Fork on GitHub and clone your fork locally
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:  Sign up for a GitHub account if you don't already have one  Go to the FreeCAD repo: https://github.com/FreeCAD/FreeCAD In the top right of the page find and press the "Fork" button (this will essentially git clone the official FreeCAD repo to your personal GitHub repo: https://github.com/GITHUB_USERNAME/FreeCAD.git)  On your machine, clone your newly created FreeCAD fork by opening a terminal and typing: git clone https://github.com/GITHUB_USERNAME/FreeCAD.git  Once the clone process is complete, now set your   remote repo (see "A note about Remotes"). Find out what and where your remote git repositories are set to. Type   and the output should look similar to: [foo@bar FreeCAD]$ git remote -v origin	https://github.com/GITHUB_USERNAME/FreeCAD.git (fetch) origin	https://github.com/GITHUB_USERNAME/FreeCAD.git (push)  Great. Now set your   repo [foo@bar FreeCAD]$ git remote add upstream https://github.com/FreeCAD/FreeCAD.git  Check your remotes again, they should look similiar to this: [foo@bar FreeCAD]$ git remote -v origin	https://github.com/GITHUB_USERNAME/FreeCAD.git (fetch) origin	https://github.com/GITHUB_USERNAME/FreeCAD.git (push) upstream	https://github.com/FreeCAD/FreeCAD.git (fetch) upstream	https://github.com/FreeCAD/FreeCAD.git (push)   Now we can start developing. Please refer to "Git Development Process"</li> </ol>

Clonare con git sulla propria macchina locale
È anche possibile iniziare, senza utilizzare il pulsante "fork":
 * 1) Clonare il codice di FreeCAD con git:
 * git clone https://github.com/FreeCAD/FreeCAD.git
 * 1) Fare le proprie modifiche al codice
 * 2) Creare un nuovo ramo
 * 3) Eseguire il Checkout a tale nuovo ramo
 * 4) Eseguire il Commit delle modifiche a tale nuovo ramo
 * 5) Creare un prorpio account a un server git pubblico (GitHub, GitLab, etc...)
 * 6) Trasferire il proprio ramo su tale server

Processo di sviluppo 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.

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 proprio repositorio GitHub
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/

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.

Resolving Merge Conflicts

 * git-scm explanation on how conflicts are presented
 * GitHub article on resolving merge conflicts via the command-line
 * Customize your preferred merge tool when you encounter a git conflict.

Applying patches via git
Git has the capability to merge patches/diffs. To read more about this read the following reference: https://www.drupal.org/node/1399218 git apply [patch-name].patch

Apply a patch via curl
A very handy and powerful feature of git and the command line is the ability to quickly test patches all through the terminal. curl -O https://github.com/FreeCAD/FreeCAD/commit/[patch-name].patch git apply [patch-name].patch or alternatively, using bash pipes you can make a sweet 1-liner: curl https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.patch | git apply -


 * Useful tip: Just add .diff or .patch at the end of the URL for a GitHub commit page, Pull Request, or Compare View and it'll show you theplaintext view of that page. Example:
 * 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

Creating patches from git
There are times when one may need to create a patch instead of submitting a PR. The following workflow explains how to do this: <ol> Make sure you are in the correct branch (i.e. not the master branch) by checking with git branch -v </li> Create the patch: we do this by using the git format-patch command which we patch against the master branch and redirect to STDOUT. We create the patch in the directory outside of the source build (in order not to pollute the source dir itself, this is optional as you can decide the location wherever you want the patch to be created) git format-patch master --stdout > ../patch.name.patch </li> </ol>

Reversing a patch in git
If you've followed the instructions above and then have a change of heart about using the patch, you can quickly reverse it using: git apply -R path/file.patch or another way is to use: git checkout -f which will remove non-committed changes to the branch

Stashing git commits
Say you're working on a branch and you find yourself making some modification to the source that is out of the scope of your current branch in other words it would be better to add certain commits to a whole other branch and submit it instead of the current one. This is where the git stash command can be very useful. The git stash command can help you to (temporarily but safely) store your uncommitted local changes. git stash Then in the future when you want to use these commits you can git stash apply or git stash pop pop will delete the stash If you have multiple stashes you can git stash list To read more about what other functions you can use checkout https://medium.freecodecamp.org/useful-tricks-you-might-not-know-about-git-stash-e8a9490f0a1a

What is the latest FreeCAD Dev Revision
There are 2 ways to do this: git rev-list --count master
 * 1st method: In your cloned git directory type:
 * 2nd method: Browse https://github.com/FreeCAD/FreeCAD and read the amount of commits FreeCAD is at.

What is the Revision number of a specific commit hash and visa ver?

 * some forum topics in this regard:
 * https://forum.freecadweb.org/viewtopic.php?f=10&t=26673
 * https://forum.freecadweb.org/viewtopic.php?t=5308
 * https://forum.freecadweb.org/viewtopic.php?f=18&t=12883&p=103207#p103203
 * https://forum.freecadweb.org/viewtopic.php?f=10&t=31118

How is the Revision number in FreeCAD help about generated?

 * https://forum.freecadweb.org/viewtopic.php?f=4&t=3025

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 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.

Using git in a Graphical User Interface

 * Developing FreeCAD with GitKraken

Ulteriori letture

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