An introductory overview of the compiler is available here.
Pull requests are encouraged.
Please follow the following guidelines:
- Add at least a test to
examples/passing/and possibly toexamples/failing. - Build the binaries and libs with
cabal build - Install the binaries and libs with
cabal install. - Run
cabal configure --enable-tests && cabal build && cabal testto build the test suite. - Run
purescript-test-everythingto make sure you haven't broken any core library builds. - Run
starter-kitto make sure the starter kit has not been broken.
If you would like to contribute, please consider the issues in the current milestone first. If you are a new contributor, you may want to have a go at the "easy" issues to get started.
Finally, if you have made code changes and would like to be included in the copyright notice in the cabal file, please include that change in your pull request.
To prevent core libraries from getting broken, every change must be reviewed. A pull request will be merged as long as one other team member has verified the changes.
Because the PureScript compiler is distributed in binary form, we include the licenses of all dependencies, including transitive ones, in the LICENSE file. Therefore, whenever the dependencies change, the LICENSE file should be updated.
You can automate this (if you have bash):
- get a copy of cabal-dependency-licenses
- run at the command line:
./license/generate > LICENSE