Skip to content

Latest commit

 

History

History
18 lines (12 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

18 lines (12 loc) · 1.16 KB
Raw

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 to examples/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 test to build the test suite.
  • Run purescript-test-everything to make sure you haven't broken any core library builds.
  • Run starter-kit to 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.