Corso "Programmazione orientata ai Microservizi" presso l'Università degli Studi di Parma (6 CFU). Questa repository è pensata per condividere le informazioni raccolte durante lo sviluppo del progetto in vista dell'esame.
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.
- 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. - Plugin utilizzati su Obsidian:
- Effettuare un
git fork
della repository in questione, nella quale poi si andranno a modificare / aggiungere appunti - Effettuare sempre un
git fetch
e successivamente ungit merge
prima di qualsiasigit push
e/ogit commit
- Non utilizzare caratteri in stampato e caratteri speciali nel nome dei file
- Utilizzare il carattere
_
al posto degli "spazi" nel nome dei file - Utilizzare sempre la numerazione dei file nel nome (i numeri indicano l'ordine degli argomenti trattati a lezione)
- Nel file
.md
inserire sempre un indice dinamico (utilizzando il plugin) e un "ritorna all'indice" alla fine di ogni paragrafo / argomento - Nel titolo dei
commit
e dellapull request
, oltre ad inserire il tema trattato, aggiungere anche il proprio username. Ad esempio il titolo di questapull request
sarà:@{tuo_username}: Aggiornamento wiki
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"
.
Made with contrib.rocks.