Il foglio di lavoro Scala (oi registri REPL) appartiene allo SCM?

0

Anche l'IDE di Eclipse Scala (e Intellij Idea) ha, insieme a una CLI REPL standard, un artefatto chiamato Foglio di lavoro , che funziona come un registro REPL persistente: l'intero file viene compilato ed eseguito al momento del salvataggio e i risultati sono allineati come commenti. È un ottimo strumento per l'esplorazione e la progettazione di API e test iniziali.

Esistono linee guida se tale file appartiene allo SCM?

Di solito non condivido quei file, perché sono spesso rozzi, con un ambito limitato e non commentati, essendo un modo per testare e provare idee diverse. A volte, tuttavia, un foglio di lavoro ottiene un valore e un contenuto informativo sufficienti a diventare prezioso.

Dovrebbe essere convertito in un test unitario o impegnato così com'è? lo trovi un modo efficace per documentare e condividere il design o qualche esempio di utilizzo di un pezzo di codice?

    
posta Michele Mauro 09.02.2018 - 15:54
fonte

2 risposte

0

Sì, se è abbastanza prezioso da essere usato ripetutamente per un periodo di più di qualche giorno, eseguendolo o semplicemente leggendolo, e in particolare se più di una persona lo userebbe, allora sì appartiene a SCM.

Questo dovrebbe rendere più facile trovare la ricerca per tutti coloro che lavorano al progetto e permetterne l'aggiornamento a fianco del codice testato.

In Consegna continua , Jez Humble e David Farley raccomandano di mantenere tutte le parti del progetto insieme nel controllo della versione, inclusi il codice sorgente, la documentazione ecc. (ma in genere non sono binari compilati).

    
risposta data 10.02.2018 - 17:29
fonte
0

Assolutamente. Sono tutti file di origine.

Chiedi se devi convertirli in test, ma in un certo senso sono già test. Chiunque acquisisca familiarità con il progetto potrebbe trovare utili esempi di come funziona.

Ci sono casi in cui potresti voler avere fogli di lavoro che fungono da scratch pad ma che non vuoi mettere il repository del progetto perché dipende da cose che sono locali al tuo ambiente di sviluppo. Ma potrebbe essere comunque una buona idea metterli nel repository di soms, specialmente se si intende usarli più di una volta.

    
risposta data 29.03.2018 - 00:46
fonte

Leggi altre domande sui tag