-
Notifications
You must be signed in to change notification settings - Fork 0
/
CONTRIBUTING
29 lines (20 loc) · 895 Bytes
/
CONTRIBUTING
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
Quick Installation Guide for another-elm/std
============================================
Contributions are very welcome, currently we do not have any explicit
guidelines.
Getting started
---------------
After cloning the repository run `$ ./x.py install` which will install some
dependencies and check other dependencies are installed. If it runs
successfully you should be good to go.
Tools
- `$ ./x.py tidy` runs formatting and automatic eslint fixing.
- `$ ./x.py check` runs all the static analysis tools we have.
- `$ ./init.py cd tests && elm-test --compiler ../another-elm` runs unit tests.
We will hopefully get a nice python sub-command for testing soon.
Acknowledgements
----------------
The vast majority of the code in another-elm is derived from the relevant elm/*
packages.
The documentation of another-elm is inspired by that of [musl].
[musl]: https://musl.libc.org/