unipr-org

• unipr-org
  • Scopo dell’Organizzazione
  • Come Partecipare
  • Linee Guida per i contributi
    • Wiki
    • Esempio
  • Contatti
  • Contributors

Benvenutə su unipr-org, l’organizzazione GitHub dedicata a riunire lɜ studentɜ di Informatica dell’Università di Parma per creare una ricca e condivisa raccolta di appunti. Siamo entusiasti di darti il benvenuto nel nostro progetto collaborativo, dove chiunque può contribuire e beneficiare dalla condivisione di conoscenze.

Scopo dell’Organizzazione

unipr-org nasce con l’obiettivo di promuovere la collaborazione e la condivisione di risorse accademiche tra lɜ studentɜ dell’Università di Parma. La nostra missione è creare una piattaforma aperta e accessibile dove si può collaborare per sviluppare una vasta raccolta di appunti, materiale didattico e risorse utili per tutti i corsi offerti dall’università.

Come Partecipare

Siamo entusiasti di accogliere nuovi membri nell’organizzazione unipr-org. Se sei unə studentə dell’Università di Parma e desideri contribuire o trarre vantaggio dalla raccolta di appunti, ecco come puoi partecipare:

1. Unisciti all’organizzazione: una volta dentro la repository del corso in questione, fai clic sul pulsante “Fork” in alto a destra per clonarla sulla tua pagina GitHub. In seguito, potrai contribuire e sottoporre richieste di pull.

2. Contribuisci con i tuoi appunti: carica i tuoi appunti, materiale didattico o risorse utili nei rispettivi repository del corso. Assicurati di seguire le linee guida per il contributo indicate nei singoli repository.

3. Apri issues: se hai suggerimenti, domande o problemi, apri una “Issue” nel repository corrispondente. Il dialogo è fondamentale per migliorare la qualità e l’efficacia della raccolta.

4. Diventa un collaboratore regolare: se sei appassionato della condivisione di conoscenze e vuoi svolgere un ruolo più attivo, contattaci per diventare un collaboratore regolare. Avrai maggiori responsabilità e potrai contribuire attivamente alla gestione dell’organizzazione.

5. Condividi la raccolta con i tuoi amici: più siamo e meglio è!

Linee Guida per i contributi

Per garantire la coerenza e la qualità della raccolta, si prega di seguire le linee guida di contributo presenti nei repository specifici dei corsi. In generale, incoraggiamo:

• L’utilizzo di formati standard per i documenti, come Markdown o PDF.
• L’inclusione di dettagli utili, come annotazioni, spiegazioni chiare e link a risorse esterne pertinenti.
• Il rispetto del lavoro degli altri e la collaborazione aperta.

Wiki

Ecco un semplice elenco di linee guida da seguire per partecipare alla stesura degli appunti e per mantenere il codice il più ordinato e leggibile possibile.

1. Per visualizzare bene gli appunti utilizzeremo Obsidian: software che permette di prendere appunti che opera su file Markdown .md. La preview che si vede su Github può risultare incompleta o non leggibile.
2. Plugin utilizzati su Obsidian:
   • table-editor-obsidian
   • highlightr-plugin
   • obsidian-automatic-table-of-content
   • todo-checklist
   • admonition
   • url-into-selection
3. Effettuare un git fork della repository in questione, nella quale poi si andranno a modificare / aggiungere appunti.
4. Effettuare sempre un git fetch e successivamente un git merge prima di qualsiasi git push e/o git commit.
5. Non utilizzare caratteri in stampato e caratteri speciali nel nome dei file.
6. Utilizzare il carattere _ al posto degli “spazi” nel nome dei file.
7. Utilizzare sempre la numerazione dei file nel nome (i numeri indicano l’ordine degli argomenti trattati a lezione).
8. Nel file .md inserire sempre un indice dinamico (utilizzando il plugin) e un “ritorna all’indice” alla fine di ogni paragrafo / argomento.
9. Nel titolo dei commit e della pull request, oltre ad inserire il tema trattato, aggiungere anche il proprio username. Ad esempio il titolo di questa pull request sarà: @{tuo_username}: Aggiornamento wiki.

Esempio

Il primo argomento trattato a lezione è stato quello del significato di “Hello, world!”.
Il nome file sarà: 01-helloworld.md.
Il titolo del commit sarà: "@{tuo_username}: Aggiunti appunti lezione 01-helloworld".
Il titolo della pull request sarà: "@{tuo_username}: Appunti lezione 26-02-2023".

Contatti

Se hai domande, suggerimenti o desideri entrare in contatto con la community unipr-org, puoi farlo attraverso:

• La nostra Pagina GitHub

Grazie per essere parte di unipr-org ! Insieme possiamo rendere l’apprendimento universitario più accessibile e collaborativo per tuttɜ lɜ studentɜ dell’Università di Parma.

Contributors