Contents

# Contributing to DNSimple/Ruby

## Getting started

#### 1. Clone the repository

Clone the repository and move into it:

```shell
git clone [e-mail]:dnsimple/dnsimple-ruby.git
cd dnsimple-ruby
```

#### 2. Install the dependencies

Install the dependencies using [Bundler](http://bundler.io/):

```
bundle
```

#### 3. Build and test

[Run the test suite](#testing) to check everything works as expected.


## Releasing

The following instructions uses `$VERSION` as a placeholder, where `$VERSION` is a `MAJOR.MINOR.BUGFIX` release such as `1.2.0`.

1. Set the version in `version.rb`:

    ```ruby
    VERSION = "$VERSION"
    ```

1. Run the test suite and ensure all the tests pass.

1. Finalize the `## main` section in `CHANGELOG.md` assigning the version.

1. Commit and push the changes

    ```shell
    git commit -a -m "Release $VERSION"
    git push origin main
    ```

1. Wait for CI to complete.

1. Create a signed tag.

    ```shell
    git tag -a v$VERSION -s -m "Release $VERSION"
    git push origin --tags
    ```

1. Build the package.

    ```shell
    rake build
    ```

1. Release to RubyGems.

    ```shell
    gem push pkg/<filename>
    ```


## Testing

To run the test suite:

```
rake
```


## 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 Travis](https://travis-ci.org/dnsimple/dnsimple-ruby).

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
dnsimple-7.0.0	CONTRIBUTING.md
dnsimple-6.0.0	CONTRIBUTING.md