CONTRIBUTING.md

Contributing

Pull requests are welcome.

Setting Up

Docker container

This app uses dependencies that are difficult to install locally. In order to make local development easy, we run app commands through a Docker container. Run the following to set this up:

make bootstrap-with-docker

Because the container caches things like packages, you will need to run this again if you change the package versions.

environment.sh

In the root directory of the repo, run:

notify-pass credentials/client-integration-tests > environment.sh

Unless you're part of the GOV.UK Notify team, you won't be able to run this command or the Integration Tests. However, the file still needs to exist - run touch environment.sh instead.

Tests

There are unit and integration tests that can be run to test functionality of the client.

Unit Tests

To run the unit tests:

make test-with-docker

Integration Tests

To run the integration tests:

make integration-test-with-docker

Releasing (for notify developers only)

To release manually, run make publish-to-rubygems. You will need to set the environment variable GEM_HOST_API_KEY, which can be found in the credentials repo under credentials/rubygems/api_key.