ianmackenzie/elm-geometry

Convert documentation examples to tests

Aperta

#27 aperta il 12 ott 2017

Vedi su GitHubGuida contributor
 (5 commenti) (0 reazioni) (0 assegnatari)Elm (28 fork)auto 404
Hacktoberfestgood first issuehelp wantedtests

Metriche repository

Star
 (186 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

I started converting a bunch of the examples shown in the documentation to tests; for example see commits 8025fe78ba15395cd07a0a410c0240c8e2e11282 and be3dbb11f58d2d79fe702aa40bc033163f25537c. It would be great if someone could help converting over more of them! As nice as it would be, I don't think it's feasible to use something like stoeffel/elm-verify-examples since most tests in this package require using custom comparison functions that include a small numerical tolerance for roundoff.

The general procedure would be to find examples in a particular module, convert them to tests in the corresponding tests file, then run the tests locally using elm-test to verify that they pass.

Guida contributor

Direzione di ricerca
Trova gli esempi di documentazione nei file sorgente del modulo, convertili in casi di test nel file di test corrispondente e assicurati che superino utilizzando elm test.
Tech stack
Nessuno
Dominio
documentationtesting
Tipo issue
Test
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitElmelm test
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80