Contributing
- Fork the repository.
- Create a topic branch.
- Implement your feature or bug fix.
- Don’t forget to add tests and make sure they pass by running
mix test. To view test coverage, run mix coveralls.html. - Make sure your code complies with the style guide by running
mix format. - If necessary, add documentation for your feature or bug fix.
- Commit and push your changes.
- Submit a pull request.
Running tests
- Run
mix test or mix coveralls.html. - Observe test results and/or code coverage.
Previewing the docs locally
- Clone the repo.
cd docsbundle exec jekyll serve --config _config.dev.yml.- Navigate to
http://localhost:4000 and observe the docs.