CONTRIBUTING.md

Contributing to DNSimple/node

Getting started

1. Clone the repository

Clone the repository and move into it:

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

2. Install the dependencies

npm install

3. Build and test

Run the test suite 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. Run the test suite and ensure all the tests pass.

2. Set the version in package.json:

   {
     "version": "$VERSION",
   }

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

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

5. Commit and push the changes

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

6. Wait for CI to complete.

7. Create a signed tag.

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

GitHub actions will take it from here and publish to npm

Testing

To run the test suite:

npm test

Tests

Submit unit tests for your changes. You can test your changes on your machine by running the test suite.