🚀 Tutorial per collaborare

Una guida passo-passo per contribuire a Sapienza Open Notes usando GitHub Desktop

1️⃣ Perché usiamo Git?

Git è un sistema che permette di collaborare senza rischiare di rovinare il lavoro degli altri. Ogni contributo viene salvato come un "checkpoint" (commit), e si può sempre tornare indietro. Usiamo GitHub come "punto di incontro online" dove tutti possono proporre le modifiche.

2️⃣ Crea un account GitHub

Per prima cosa registrati gratuitamente su 👉 github.com.

Questo ti servirà per avere il tuo spazio personale dove salvare le modifiche.

3️⃣ Fai un fork del progetto

Vai alla repository ufficiale: 👉 Sapienza Open Notes su GitHub .

Premi sul pulsante Fork in alto a destra: creerai una copia tutta tua del progetto, indipendente da quella principale. Così puoi lavorarci senza rischiare di rompere nulla.

4️⃣ Clona il progetto con GitHub Desktop

Scarica e installa GitHub Desktop.

Poi aprilo e scegli File → Clone Repository. Inserisci l’URL del tuo fork:

https://github.com/TUO_USERNAME/SapienzaOpenNotes.git

Ora hai una copia locale del progetto sul tuo computer.

5️⃣ Crea un branch

Per ogni modifica (nuova lezione, correzione, aggiunta di immagini) crea un branch. Un branch è come un "binario parallelo" su cui lavori senza toccare i file principali.

In GitHub Desktop premi su Current Branch → New Branch e scrivi un nome descrittivo, ad esempio:

6️⃣ Aggiungi o modifica i file

Segui la struttura delle cartelle: faculty/undergraduate/course/instructor/lectures/ e rispetta le linee guida.

Puoi aggiungere nuove lezioni in LaTeX, immagini, o correggere errori nei file già presenti.

7️⃣ Salva le modifiche (Commit)

Ogni volta che fai una modifica, GitHub Desktop ti mostra i file cambiati. Scrivi un messaggio chiaro che descrive cosa hai fatto, ad esempio:

Poi premi Commit to nome-del-tuo-branch. Questo crea un "checkpoint" sicuro del tuo lavoro.

8️⃣ Carica le modifiche online (Push)

Dopo il commit, premi Push origin. In questo modo le tue modifiche passano dal tuo computer al tuo fork su GitHub. Ora gli altri possono vederle.

9️⃣ Proponi le modifiche (Pull Request)

Vai sul tuo fork su GitHub. Ti apparirà un messaggio che dice Compare & pull request.

Premi il pulsante, aggiungi una descrizione chiara e invia. Questa è una proposta: il team potrà leggere i tuoi cambiamenti e decidere di integrarli.

🎉 Fatto!

Hai contribuito a Sapienza Open Notes e reso il progetto più utile per tutta la comunità 💡

⬅️ Torna alla Home