Skip to content

Latest commit

 

History

History
26 lines (14 loc) · 697 Bytes

CONTRIBUTING.md

File metadata and controls

26 lines (14 loc) · 697 Bytes

Contributing

  1. Fork the project and clone your fork.

  2. Checkout the development branch with: git checkout development

  3. Run stack init to setup the project's stack environment.

  4. Create a feature branch with: git checkout -b <branch>

  5. Add your functionality:

a. Put it in the appropriate place under the ./src folder.

b. Add tests for the functionality in appropriate files under the ./test folder.

c. Import and run the tests inside the test/Main.hs testing entry point.

d. Fill out the test coverage as best you can.

  1. Run stack test to run the tests.

  2. Push your changes: git push origin <branch>

  3. Open a pull request.