Guidaappunti-condivisi.txt

Questa guida spiega le regole generali di utilizzo del repository.

Voi avete il diritto di modificare tutto come vi pare, purchè la modifica sia in meglio.
È ovvio però che se la modifica la fate ad un file che non vi appartiene (esempio attuale
è la cartella GammaFunction) dovete pensarci molte volte. Avete il diritto di correggere
errori, ma allo stesso tempo sarebbe meglio se piuttosto che correggerli esplicitamente
vi limitiate a commentare su github l'ultimo commit al file dicendo l'errore.

Questo repository è pensato per tenere degli appunti in latex. Perciò ha delle
configurazioni adatte a questo.
In particolare attualmente git ignora i file che finisco con .pdf o con altre estensioni
collegate con il latex che non vogliamo finiscano online (ad esempio .aux .toc
.log .backup).
I file pesanti NON vanno committati a meno che non sia strettamente necessario.
Per quanto riguarda le immagini ovviamente il discorso è a parte. Deciso che in
un pdf volete aggiungere un'immagine, allora potete metterla nel repo. Anche in questo 
caso pensate però che il peso dell'immagine graverà sul repo per sempre ;)

La struttura generale del repository è:
	Una cartella per ogni progetto latex.
	Ogni progetto latex definisce il suo standard di latexazione.


Non ci sono regole sul tipo di documenti che volete condividere. È importante solo
che siano scritti da voi.
Per quanto mi riguarda potete anche fare un progetto in tex che illustri il kamasutra
in versione normalista (cosa che mi spaventa).

Per quanto riguarda la gestione di git suggerisco questa politica:
	Ogni volta che create un nuovo file seguite questa procedura:
		Create il file.
		Addate il file, committate (dicendo che avete aggiunto il file e ci state lavorando)
		e pushate.
		Una volta che avete finito di lavorare sul file committate di nuovo (dicendo che
		avete finito per ora) e pushate.
		
	Mentre lavorate su un file sono molto apprezzati commit frequenti (non intendo
	ogni riga, ma ogni tanto (diciamo 30 minuti) fare un commit e saggio).
	Push frequenti (diciamo 30 minuti) sono anche apprezzati così che se più gente sta lavorando
	non succede di lavorare sullo stesso file.
	Queste 2 regole sono di massima e non obbligatorie.
		
	Se la modifica è minima potete commentare il commit con "fix" e basta.
	
	Se non avete finito di modificare dei files, ma state per smettere di farla per
	qualche motivo committate il cambiamento. Anche cose non finite
	possono e devono stare sul repository ;) Fate però in modo che gli altri non
	abbiano problemi di compilazione del latex (warning sono accettati) a causa vostra. 

In generale quando terminate di lavorare su un file assicuratevi sia
che tutto quanto compili (cioè il tex diventi un pdf senza problemi), sia
che non ci siano warning durante la compilazione. Questo lo dico perchè
se si accumulano i warning poi diventa impossibile lavorare, e anche perchè
se c'è un warning c'è un motivo.