Skip to content

Commit

Permalink
Merge branch 'main' into fix/otel-trace-propagation-targets
Browse files Browse the repository at this point in the history
  • Loading branch information
adinauer committed Feb 24, 2025
2 parents 94231c6 + 55c9166 commit 855b01a
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,36 @@ To run the build and tests:
make compile
```

# Format

To format the changed code and make CI happy you can run:

```shell
make format
```

or

```shell
./gradlew spotlessApply
```

# Binary compatibility validation

To prevent breaking ABI changes and exposing things we should not, we make use of https://github.com/Kotlin/binary-compatibility-validator. If your change intended to introduce a new public method/property or modify the existing one you can overwrite the API declarations to make CI happy as follows (overwrites them from scratch):

```shell
make api
```

or

```shell
./gradlew apiDump
```

However, if your change did not intend to modify the public API, consider changing the method/property visibility or removing the change altogether.

# CI

Build and tests are automatically run against branches and pull requests
Expand Down

0 comments on commit 855b01a

Please sign in to comment.