Packages

dnsimple

7.0.1
10.0.0 9.0.0 8.3.0 8.2.0 8.1.0 8.0.0 7.0.1 7.0.0 6.0.1 6.0.0 5.0.1 5.0.0 4.0.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.1 3.1.1 3.1.0 3.0.2 3.0.1 3.0.0 2.0.0 1.4.1 1.4.0 1.3.0 1.2.0 1.1.1 1.1.0 1.0.1 1.0.0 0.9.2 0.9.1 0.9.0 0.1.0 0.0.1

Elixir client for the DNSimple API v2.

HexDocs

Current section

Files

Jump to
Readme
39 Versions
3 Dependencies
Dependants
Files
Activity
dnsimple CONTRIBUTING.md
Raw

CONTRIBUTING.md 

# Contributing to DNSimple/Elixir



## Getting started



### 1. Clone the repository



Clone the repository and move into it:



```shell

git clone git@github.com:dnsimple/dnsimple-elixir.git

cd dnsimple-elixir

```



### 2. Install Elixir



### 3. Install the dependencies



```shell

mix deps.get

```



### 4. Build and test



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



```shell

mix test

```





## Tests



Submit unit tests for your changes. You can test your changes on your machine by [running the test suite](#testing).



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).