Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

53 lines (33 loc) · 1.2 KB
Raw

Contribution guide

Welcome and thanks for thinking about contributing to Klogging.

This guide is a work in progress.

What to contribute?

Have a look at the current issues, or create a new issue or pull request if you see something that needs attention.

You can also create a pull request with changes to Klogging’s documentation if you see something that needs fixing or changing.

How to get started?

Prerequisites:

  • Java version 11 or above.
  • Git

Klogging currently only supports building for the JVM.

Run tests with:

./gradlew jvmTest

Fix linting with:

./gradlew spotlessApply

Build the library jar with:

./gradlew jvmJar

Pull request guidelines

  • All commits must be signed.

  • All code should have passing unit tests in the jvmTest module.

  • All code should have comprehensive KDoc comments. We publish all KDoc, including non-public code.

  • Please limit PRs to one bugfix or feature.