CONTRIBUTING.md

Contributing to DNSimple/PHP

Getting started

1. Clone the repository

Clone the repository and move into it:

git clone [email protected]:dnsimple/dnsimple-php.git
cd dnsimple-php

2. Install dependencies

Install composer locally.

Install the dependencies using composer:

composer install

3. Testing

Run the test suite to check everything works as expected.

To run the test suite:

./vendor/bin/phpunit tests

Releasing

💡 A new release is not necessary for changes to composer.lock because they do not have an effect on projects that depend on dnsimple-php.

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 Client.php:

const VERSION = "$VERSION";

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

   ./vendor/bin/phpunit tests

2. Finalize the ## main section in CHANGELOG.md assigning the version.

3. Commit and push the changes

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

4. Wait for the CI to complete.

5. Create a signed tag.

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

6. Wait for Packagist to pull the updates. Verify dnsimple/dnsimple package is updated with the new release.

Testing

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.