Contributing to DNSimple/Python

Getting Started

Clone the repository and move into it:

git clone git@github.com:dnsimple/dnsimple-python.git
cd dnsimple-python

Poetry is used by this library, so ensure you have it installed.

Make sure you have Python installed.

Init the project

poetry install

To start a shell in the virtual environment:

poetry shell

Testing

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

To run the test suite:

make test

When you submit a PR, tests will also be run on the continuous integration environment via GitHub Actions.

Changelog

We follow the Common Changelog format for changelog entries.