bin | ||
docs | ||
exercises | ||
.gitignore | ||
.travis.yml | ||
config.json | ||
elm-package.json | ||
LICENSE | ||
README.md | ||
SETUP.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.
-
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 problem should have a test suite, an example solution, and a template file for the real implementation. 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 namedExerciseModuleName.elm
. Test file should be namedExerciseModuleNameTest.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
config.json
. Also, please runbin/fetch-configlet && bin/configlet
to ensure the exercise is configured correctly.
License
The MIT License (MIT)
Copyright (c) 2016 Katrina Owen, _@kytrinyx.com