Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (25 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 1.21 KB
Raw

Contributing to the Conductor Java SDK

Thanks for contributing. This repository contains the Java client, AI agent SDK, Spring integrations, examples, and end-to-end tests.

All participation is governed by the Code of Conduct.

Prerequisites

  • Java 21+
  • Docker for examples and integration tests that start Conductor

Local checks

Run formatting before committing:

./gradlew spotlessApply

Run the SDK test suite:

./gradlew test jacocoTestReport

Compile the maintained agent examples when changing their APIs or documentation:

./gradlew :agent-examples:compileJava

Pull requests

  • Keep changes focused and include tests for behavior changes.
  • Update the relevant documentation and examples when public APIs or commands change.
  • Do not add secrets, credentials, or private endpoints to source, tests, or documentation.
  • Open pull requests against main and complete the pull-request template.

To contribute across the broader project, browse Conductor OSS contribution opportunities and follow the upstream contribution guide.