mirror of
https://github.com/correl/elm.git
synced 2024-12-19 11:12:23 +00:00
Update README with dev workflow
This commit is contained in:
parent
a082e0ffd9
commit
9e02b169e0
1 changed files with 17 additions and 1 deletions
18
README.md
18
README.md
|
@ -5,7 +5,14 @@ Exercism Exercises in Elm
|
|||
|
||||
## Setup
|
||||
|
||||
Detailed installation instructions can be found at [http://elm-lang.org/install](http://elm-lang.org/install).
|
||||
The simplest way to install Elm is via Node.js/NPM.
|
||||
|
||||
If you don't already have Node.js installed on your computer, you can download it from [the official site](https://nodejs.org/). Once you have Node.js up and running, follow these steps to install the Elm platform and elm-test.
|
||||
|
||||
```bash
|
||||
$ npm install --global elm elm-test
|
||||
```
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
|
@ -36,6 +43,15 @@ Please keep the following in mind:
|
|||
|
||||
- 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`.
|
||||
|
||||
- The recommended workflow when working on an exercise is to first create the implementation and test files, `ExerciseModuleName.elm` and `ExerciseModuleNameTest.elm`.
|
||||
- Test the new exercise directly by running `elm-test exercises/exercise_module_name/ExerciseModuleNameTest.elm`.
|
||||
|
||||
- Once the implementation of the exercise is complete, move `ExerciseModuleName.elm` to `ExerciseModuleName.example` and create the template file.
|
||||
|
||||
- Make sure everything is good to go by running all tests with `bin/build.sh`.
|
||||
|
||||
- Please do not commit any Elm configuration files or directories inside the exercise, such as `elm-stuff`. Please include only the standard `elm-package.json`.
|
||||
|
||||
- Test files should use the following format:
|
||||
|
||||
```elm
|
||||
|
|
Loading…
Reference in a new issue