CONTRIBUTING.md

Contributing

• Contributing
  • Getting Started
  • Configuration
  • Compilation
  • Testing
  • Running
  • Releasing

Getting Started

Clone the repository in your workspace and move into it:

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

Install standard Go development tooling:

make install-tools

Configuration

To configure a local CoreDNS server:

cp Corefile.example Corefile
vim Corefile

Compilation

make build

This will produce a coredns-dnsimple binary in the current directory.

Testing

To run the unit test suite:

make test

Running

make start

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.go:

   PluginVersion = "$VERSION"

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

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

4. Commit and push the changes

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

5. Wait for CI to complete.

6. Release the version.

   make release VERSION=$VERSION