github/elm

mirror of https://github.com/correl/elm.git synced 2024-12-18 11:06:17 +00:00

Exercism exercises in Elm.

Find a file

Lew Parker 98c66d94c6 Merge pull request #33 from tgecho/cache-travis-elm-stuff Cache elm-stuff directory in travis		2016-03-14 06:50:32 -06:00
bin	Exit build.sh with an error if one of the exercise examples fails the test run	2016-03-13 21:09:37 -04:00
docs	Add basic ABOUT/RESOURCES docs	2016-03-13 15:55:48 -04:00
exercises	Update docs and hello-world to reflect exercise specific elm-package.json files.	2016-03-13 15:55:48 -04:00
.gitignore	Setup Hello World and top level testing	2016-02-22 20:29:13 -07:00
.travis.yml	Merge pull request #33 from tgecho/cache-travis-elm-stuff	2016-03-14 06:50:32 -06:00
config.json	Fix hello world slug	2016-03-13 12:56:53 -06:00
elm-package.json	Exit build.sh with an error if one of the exercise examples fails the test run	2016-03-13 21:09:37 -04:00
LICENSE	Bootstrap elm track	2015-09-08 13:03:25 -06:00
README.md	Update docs and hello-world to reflect exercise specific elm-package.json files.	2016-03-13 15:55:48 -04:00
SETUP.md	Bootstrap elm track	2015-09-08 13:03:25 -06:00

README.md

xElm

Exercism Exercises in Elm

Setup

Detailed installation instructions can be found at http://elm-lang.org/install.

Contributing

Thank you so much for contributing! 🎉

Please start by reading the general Exercism contributing guide.

We welcome pull requests that provide fixes and improvements to existing exercises. If you're unsure, then go ahead and open a GitHub issue, and we'll discuss the change.

Please keep the following in mind:

Pull requests should be focused on a single exercise, issue, or change.
We welcome changes to code style, and wording. Please open a separate PR for these changes if possible.
Please open an issue before creating a PR that makes significant (breaking) changes to an existing exercise or makes changes across many exercises. It is best to discuss these changes before doing the work.
Follow the coding standards found in The Elm Style Guide. Please consider running elm-format before submitting a pull request.
Watch out for trailing spaces, extra blank lines, and spaces in blank lines.
Each exercise must stand on its own. Do not reference files outside the exercise directory. They will not be included when the user fetches the exercise.
Exercises should use only the Elm core libraries.
Please do not add a README or README.md file to the exercise directory. The READMEs are constructed using shared metadata, which lives in the exercism/x-common repository.
Each exercise should have a test suite, an example solution, a template file for the real implementation and an elm-package.json file with the elm-test and elm-console dependencies. The CI build expects files to be named using the following convention. The example solution should be named ExerciseModuleName.example. The template file should be named ExerciseModuleName.elm. Test file should be named ExerciseModuleNameTest.elm.
Test files should use the following format:

import Task
import Console
import ElmTest exposing (..)


tests : Test
tests =
  suite "ExerciseModuleName"
    [ test "first test" (assertEqual True True)
    , test "second test" (assertEqual False False)
    ]


port runner : Signal (Task.Task x ())
port runner =
  Console.run (consoleRunner tests)

All the tests for xElm exercises can be run from the top level of the repo with bin/build.sh. Please run this command before submitting your PR.
If you are submitting a new exercise, be sure to add it to the appropriate place in the config.json and elm-package.json files. Also, please run bin/fetch-configlet && bin/configlet to ensure the exercise is configured correctly.

License

The MIT License (MIT)