CONTRIBUTING.md

December 2, 2017 ยท View on GitHub

So you want to contribute? Awesome! Welcome aboard!

Steps

  1. Fork and clone
  2. Install dependencies
  3. Hack, in no particular order:
    • Write enough code
    • Write tests for that code
    • Check that other tests pass
    • Repeat until you're satisfied
  4. Submit a pull request

For and clone

First step is to fork it at http://help.github.com/fork-a-repo/ and create your own clone of mort.

Running the Tests

Running the tests is as easy as:

make tests

You should see the results of running your tests after an instant.

Format code

make format