Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
21 lines (13 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

21 lines (13 loc) · 1.29 KB
Raw

Getting Started

  1. Fork this repo on Github and clone it locally
  2. npm install to grab dependencies
  3. npm run cleanbuild && npm run test to build and run tests
  4. Make your changes (and add appropriate tests)
  5. Open a pull request with your changes

Code style and conventions

We use Relude as our standard library, so try to avoid using Belt or Pervasives when working with lists, options, etc.

Also, please make sure that your code has been formatted with refmt.

Tests

relude-eon doesn't quite have full test coverage, but if you want to help us get there, we'd be very grateful. :) Running npm run coverage will run your tests and give you a coverage report. You can see the detailed report in ./docs/coverage/lcov-report/index.html, which will help you track down any uncovered functions or branches.

Documentation

Currently documentation only exists in the rei files. While some modules are fully documented, others are very lacking. Any improvements or additions you wish to make are welcome, and please add interfaces and doc comments as appropriate when adding new features.