@@ -2,14 +2,15 @@ An introductory overview of the compiler is available [here](https://www.youtube
3Pull requests are encouraged.
3Pull requests are encouraged.
5Please follow the following guidelines:
7Please follow the following guidelines:
7- Add at least a test to `examples/passing/` and possibly to `examples/failing`.
9- Add at least a test to `examples/passing/` and possibly to `examples/failing`.
8- Build the binaries and libs with `cabal build`
10- Build the binaries and libs with `cabal build`
9- Install the binaries and libs with `cabal install`.
11- Install the binaries and libs with `cabal install`.
10- Run `cabal configure --enable-tests && cabal build && cabal test` to build the test suite.
12- Run `cabal configure --enable-tests && cabal build && cabal test` to build the test suite.
11−- Run `purescript-test-everything` to make sure you haven't broken any core library builds.
13+- Build the core libraries by running the script in `core-tests`
12−- Run `starter-kit` to make sure the starter kit has not been broken.
14If 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](https://github.com/purescript/purescript/labels/easy) to get started.
15If 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](https://github.com/purescript/purescript/labels/easy) to get started.
@@ -17,7 +18,7 @@ Finally, if you have made code changes and would like to be included in the copy
18To 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.
19To 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.
20−## Adding dependencies
21+## Adding Dependencies
22Because the PureScript compiler is distributed in binary form, we include
23Because the PureScript compiler is distributed in binary form, we include
23the licenses of all dependencies, including transitive ones, in the LICENSE
24the licenses of all dependencies, including transitive ones, in the LICENSE
@@ -30,3 +31,8 @@ You can automate this (if you have bash):
30- run at the command line: `./license/generate > LICENSE`
31- run at the command line: `./license/generate > LICENSE`
32[cabal-dependency-licenses]: https://github.com/jaspervdj/cabal-dependency-licenses
33[cabal-dependency-licenses]: https://github.com/jaspervdj/cabal-dependency-licenses
37+- If the issue is actually a question, please consider asking on Reddit, Stack Overflow or IRC first.
38+- Please include a minimal, repeatable test case with any bug report.