Skip to content
This repository has been archived by the owner on Apr 27, 2021. It is now read-only.

Latest commit

History

History
47 lines (32 loc) 路 1.09 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) 路 1.09 KB

Contributing

Thanks for contributing! :)

exfmt is an open project, contributions are very much welcomed. If you have feedback or have found a bug, please open an issue. If you wish to make a code contribution please open a pull request, though for larger code changes it may be good to open an issue first so we can work out the best way to move forward.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Setup

Currently exfmt targets the Elixir master branch as it uses features arrving in Elixir v1.6. This can be installed either manually or using the asdf version manager.

# Install Elixir master using asdf
asdf install elixir master-otp-20

# Install the deps
mix deps.get

Quick Reference

# Run the tests
mix test

# Run the tests when files change
mix test.watch

# Run the type checker
mix dialyzer