Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (49 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

77 lines (49 loc) · 2.04 KB

Contributing

Welcome to the OpenTelemetry Java Contrib repository!

Introduction

This repository provides observability libraries and utilities for Java applications that complement the OpenTelemetry Java SDK and OpenTelemetry Java Instrumentation projects.

Before submitting new features or changes, please consider opening an issue first to discuss your ideas.

Pull requests for bug fixes are always welcome!

Building and Testing

While most modules target Java 8, building this project requires Java 21 or higher.

To build the project:

./gradlew assemble

To run the tests:

./gradlew test

Markdown linting

This repository uses markdownlint via markdownlint-cli2 managed by mise.

To check all Markdown files:

mise run lint:markdown

(note: Windows users may need to run mise install first)

To automatically fix fixable issues:

mise run lint:markdown --fix

Snapshot Builds

Snapshot builds of the main branch are available from the Sonatype snapshot repository at: https://central.sonatype.com/repository/maven-snapshots/ (browse).

Style Guide

See Style Guide.

Pull Request Guidelines

When submitting a pull request, please ensure that you:

  • Clearly describe the change and its motivation
  • Mention any breaking changes
  • Include tests for new functionality
  • Follow the Style Guide

Getting Help

If you need assistance or have questions: