L'idea è di comporre un documento "vivente" che possa essere d'aiuto agli studenti del Dipartimento d'Informatica dell'Università degli Studi di Torino.
Il repository è da immaginare in questo caso come un archivio, contenente:
- Esperienze degli studenti
- Appunti prodotti dagli studenti e resi pubblici (grazie!)
- Prove d'esame degli anni passati
- Domande degli esami (e risposte)
- Guide per aiutare gli studenti nella vita universitaria (di varia complessità)
Nonostante l'organizzazione e la struttura del repository sia ancora da finalizzare, abbiamo comunque una serie di linee guida per chi ha il piacere di contribuire.
Questa sezione si riferisce alla cartella Materie
Dal momento che non bastano mai, e ogni anno comunque i programmi cambiano un po', gli appunti sono sempre utili e ben accetti.
In generale sono preferibili se in forma digitale, e ancora meglio se sono forniti assieme al sorgente (ad esempio LaTeX o Markdown). In ogni caso, dei PDF col testo selezionabile vanno più che bene.
Per maggiori informazioni sull'aggiunta di appunti, ti invito a leggere le indicazioni nella sezione materie.
Nel caso voleste condividere progetti dopo la sessione, aggiungeteli come git submodule. Ad esempio per aggiungere un progetto di ASD relativo all'anno accademico 2022/2023, potete fare:
git submodule add <url_del_repo> Materie/ASD/2022-2023/<cognomi_studenti>Come per gli appunti, anche le prove d'esame sono ben accette! Come prima, ti invito a leggere le indicazioni nella sezione materie.
Come abbiamo accennato precedentemente, questo repository non è solo un archivio, ma punta a essere una piccola guida.
Abbiamo notato che ci sono molti argomenti sul sito dell'Ateneo e del Dipartimento che non sono ben spiegati, o che sono nascosti in luoghi non facilmente accessibili. Per questo motivo abbiamo pensato che fosse utile per tutti avere una knowledgebase degli argomenti più "popolari".
Al momento le guide non sono tante, ma puntiamo ad aggiungerne di più per fornire indicazioni agli studenti, su argomenti che vanno dall'immatricolazione fino al procedimento per la laurea.
Un goal sarà anche indicare per i corsi effettivamente cosa si fa, abbastanza nei dettagli, ma spiegato senza troppe complicazioni. Stessa cosa per i progetti.
Questo può essere utile per capire per quali corsi un certo corso può essere utile successivamente, o per comprendere meglio se interessi al lettore o meno (a volte i nomi sono fuorvianti e anche le descrizioni non sono sempre chiarissime o aggiornate).
Per adesso abbiamo pensato ad alcune linee guida "base" che è suggerito tenere a mente:
- Indicare per ogni risorsa link ufficiali (dipartimento, ateneo, ...), preferibilmente che non possano "cadere"
- I messaggi di commit devono essere significativi e autodescrittivi, nonché non troppo grossi. Si veda questo articolo per alcuni chiarimenti.
- In più, i messaggi di commit devono seguire la strategia dei conventional commits, specificando se possibile lo scope.
- Se vengono caricati files provenienti da altri siti (che lo permettono), indicarne la provenienza. In genere se è materiale per un corso, un file README nella directory va più che bene.
- All'upload degli appunti di una nuova materia, inserirli dentro una apposita cartella
Appunticreata nella root. - Non sarà accettato materiale dei docenti (slides loro, senza appunti o simili di uno studente)
Per inizializzare i submodules, dopo aver clonato il repository, è sufficiente eseguire il seguente comando:
git submodule update --init --recursivePer favore, qualunque suggerimento, issue o pull request che vi venga in mente fatela!
Una piccola nota finale: l'unico scopo del repository è essere una risorsa utile per la vita universitaria, NON un modo per copiare o condividere materiale che non è condivisibile. Ci riserviamo l'ultima parola sulle decisioni.
~ Il Team Studentesco Informatica :)
Tutto il materiale coperto da copyright è coperto dalla propria licenza; il resto del repository (comprese le contribuzioni) è sotto licenza Creative Commons Attribution-ShareAlike 4.0 International.
Fare riferimento al file LICENSE per maggiori informazioni.