ianmackenzie/elm-geometry

Convert documentation examples to tests

Open

#27 opened on Oct 12, 2017

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)Elm (28 forks)auto 404
Hacktoberfestgood first issuehelp wantedtests

Repository metrics

Stars
 (186 stars)
PR merge metrics
 (PR metrics pending)

Description

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.

Contributor guide

Research direction
Locate documentation examples in the module source files, convert them into test cases in the corresponding test file, and ensure they pass using elm test.
Tech stack
None
Domain
documentationtesting
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitElmelm test
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80