Interested in contributing to the project? We appreciate all kinds of help!
We gladly welcome pull requests.
Before making any changes, we recommend opening an issue (if it doesn’t already exist) and discussing your proposed changes. This will let us give you advice on the proposed changes. If the changes are minor, then feel free to make them without discussion.
To make changes, fork the repo. Write code in this fork with the following guidelines. Some of these checks are performed automatically by CI whenever a branch is pushed. These automated checks must pass before a PR will be merged. The checks can also be used in a commit/push hook with the following script.
mix compile --warnings-as-errors --force || exit 1
mix format --check-formatted || exit 1
mix test || exit 1
mix credo --strict -i todo || exit 1
mix dialyzer --halt-exit-status || exit 1For better or worse, we use the Elixir formatter. You can run mix format
prior to checkin to format your changes.
speechmarkdown-ex uses the credo tool to check consistency and find bugs.
You can run mix credo --strict to evaluate these checks. We also use
dialyzer for typespec checking.
We strive to keep test coverage as high as possible using excoveralls.
Coverage can be checked by running mix coveralls.html for an HTML report.