Skip to content

Update contributing docs #4505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 16, 2025
Merged

Update contributing docs #4505

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,31 @@ and then you can find the java agent artifact at

`agent/agent/build/libs/applicationinsights-agent-<version>.jar`.

## Updating dependencies

When updating dependencies in the project, you need to regenerate the dependency lock files
and license reports.

### Regenerate lock files

After updating dependencies in any `build.gradle.kts` file, regenerate the lock files:

```bash
./gradlew resolveAndLockAll --write-locks
```

This will update all `gradle.lockfile` files throughout the project to reflect the new dependency versions.

### Regenerate license files

After updating dependencies, regenerate the license report to include licenses for new dependencies:

```bash
./gradlew generateLicenseReport --no-build-cache
```

This ensures all third-party licenses are properly documented.

## IntelliJ setup and troubleshooting

See [IntelliJ setup and troubleshooting](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/contributing/intellij-setup-and-troubleshooting.md)
Expand Down