open-telemetry / open-telemetry/opentelemetry-java

Publish otel.spotless-conventions?

Open
#4,076 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature Request
Dominant language
Java
Stars
2.5k
Forks
1k
Avg merge
3d 17h
Merged PRs (30d)
58

Description

Pros:

This would enable us to use it across all 4 java repos (core, instrumentation, contrib, docs).

In particular, instrumentation repo has many standalone gradle modules, which currently requires copying spotless configuration across each one (https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/5058).

Cons:

It's really just for use on OpenTelemetry projects, given that it adds our license header, as opposed to something public for others to use:

/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the copied Spotless configuration in the instrumentation repository and the context in pull request #5058. Compare how the configuration is used across the core, instrumentation, contrib, and docs repositories. Done would require a decided approach for publishing and sharing the convention, but this old issue does not define that scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.