CONTRIBUTING.md
# Contributing to DNSimple/Elixir
## Getting started
Clone the repository and move into it:
```shell
git clone git@github.com:dnsimple/dnsimple-elixir.git
cd dnsimple-elixir
```
Install Elixir and the dependencies:
```shell
mix deps.get
```
Compile the project and [run the test suite](#testing) to check everything works as expected.
## Changelog
We follow the [Common Changelog](https://common-changelog.org/) format for changelog entries.
## Testing
Run the test suite:
```shell
mix test
```
Submit unit tests for your changes. You can test your changes on your machine by running the test suite.
When you submit a PR, tests will also be run on the [continuous integration environment via GitHub Actions](https://github.com/dnsimple/dnsimple-elixir/actions).