CONTRIBUTING.md · rowtype-yoga/purescript-native

git.iko.soy/rowtype-yoga/purescript-native

rowtype-yoga/purescript-native/CONTRIBUTING.md

39 lines 1.7 kB history raw

1An introductory overview of the compiler is available [here](https://www.youtube.com/watch?v=Y3P1dxqwFiE).

3Pull requests are encouraged.

5## Finding Issues to Work On

7If 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.

9## Pull Requests

11Please follow the following guidelines:

13- Add at least a test to `examples/passing/` and possibly to `examples/failing`.

14- Build the binaries and libs with `cabal build`

15- Install the binaries and libs with `cabal install`.

16- Run `cabal configure --enable-tests && cabal build && cabal test` to build the test suite. You will need `npm` and `node` on your PATH to run the tests.

17- Build the core libraries by running the script in `core-tests`.

19## Code Review

21To 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.

23## Adding Dependencies

25Because the PureScript compiler is distributed in binary form, we include

26the licenses of all dependencies, including transitive ones, in the LICENSE

27file. Therefore, whenever the dependencies change, the LICENSE file should be

28updated.

30This can be automated; see the `license-generator/generate.hs` file.

32## Writing Issues

34- If the issue is actually a question, please consider asking on Reddit, Stack Overflow or IRC first.

35- Please include a minimal, repeatable test case with any bug report.

37## Copyright and Licensing

39For any code change, please append a copyright and licensing notice to the [CONTRIBUTORS.md](CONTRIBUTORS.md) file.