Playground

I repository Playground

Sono particolari repository che invece di contenere un progetto specifico nascono con lo scopo di contenere snippets, esempi di utilizzo di una certa tecnologia, use-cases testati e documentati ecc.

Per questo tipo di repository cerchiamo di inserire nel nome il riferimento alla teconologia utilizzata, e usare il suffisso "-playground" per identificarli rispetto ai progetti standard.

Un esempio è node-red-playground

Cerchiamo inoltre di documentare il più possibile il contenuto dei playground, in modo da rendere semplice il riutilizzo del codice o la replica dei circuiti da parte di altri utenti.

Se si tratta di SW, commentiamo sempre molto bene il nostro codice.

In alternativa o a complemento dei commenti nel codice, usiamo i files README.md e lo strumento Wiki di GitHub per descrivere l'architettura HW/SW e il dettaglio delle singole parti.

Contenuto dei repository Playground

Ogni repository Playground dovrebbe contenere tipicamente:

• un file README.md che descrive il respository ed elenca il contenuto
• sorgenti di esempio per use-cases particolari
• documenti/wiki che descrivono particolari situazioni di utilizzo
• documenti con link a tutorial
• schemi elettronici o cad
• tutto quello che può essere utile per approfondire quella tecnologia