PoaM - Programmazione orientata ai Microservizi

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.

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".

---

Contributors

Made with contrib.rocks.