Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (26 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

44 lines (26 loc) · 1.16 KB

Contributing to DNSimple/Java

Getting started

Clone the repository and move into it:

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

Install Eclipse Temurin JDK 21.0.5+11-LTS from https://adoptium.net/es/temurin/releases/.

Run the test suite to check everything works as expected.

You can install this project into your local Maven repository by running:

./gradlew clean publishToMavenLocal

(use gradlew.bat in Windows instead)

You can then import it into any project as if it were published to the Maven Central repo.

Changelog

We follow the Common Changelog format for changelog entries.

Testing

To run the test suite:

./gradlew clean test

(use gradlew.bat in Windows instead)

Requirements for contributing code to this repo

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.