Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

38 lines (23 loc) · 1.58 KB
Raw

An introductory overview of the compiler is available here.

Pull requests are encouraged.

Finding Issues to Work On

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.

Pull Requests

Please follow the following guidelines:

  • Add at least a test to examples/passing/ and possibly to examples/failing.
  • Build the binaries and libs with stack build
  • Run the test suite with stack test. You will need npm and node on your PATH to run the tests.
  • Build the core libraries by running the script in core-tests.

Code Review

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.

Adding Dependencies

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.

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

Writing Issues

  • If the issue is actually a question, please consider asking on Reddit, Stack Overflow or IRC first.
  • Please include a minimal, repeatable test case with any bug report.

Copyright and Licensing

For any code change, please append a copyright and licensing notice to the CONTRIBUTORS.md file.