Skip to content

Latest commit

 

History

History
58 lines (51 loc) · 2.16 KB

AGENTS.md

File metadata and controls

58 lines (51 loc) · 2.16 KB

Contributor Quickstart Guide

Repository Layout

  • temporal-sdk: core SDK implementation.
  • temporal-testing: utilities to help write workflow and activity tests.
  • temporal-test-server: in-memory Temporal server for fast tests.
  • temporal-serviceclient: gRPC client for communicating with the service.
  • temporal-shaded: prepackaged version of the SDK with shaded dependencies.
  • temporal-spring-boot-autoconfigure: Spring Boot auto configuration.
  • temporal-kotlin: Kotlin DSL for the SDK.
  • temporal-opentracing: OpenTracing interceptor integration.

General Guidance

  • Avoid changing public API signatures. Anything under an internal directory is not part of the public API and may change freely.
  • The SDK code is written for Java 8.

Building and Testing

  1. Format the code before committing: 
    ./gradlew --offline spotlessApply
  2. Run the tests. This can take a long time so you may prefer to run individual tests. 
    ./gradlew test
    To run only the core SDK tests or a single test: 
    ./gradlew :temporal-sdk:test --offline --tests "io.temporal.workflow.*"
./gradlew :temporal-sdk:test --offline --tests "<package.ClassName>"
  3. Build the project: 
    ./gradlew clean build

Tests

  • All tests for this each package is located in $PACKAGE_NAME/src/test/java/io/temporal, where $PACKAGE_NAME is the name of the package
  • Workflow API tests should rely on SDKTestWorkflowRule to create a worker and register workflows, activities, and nexus services.

Commit Messages and Pull Requests

  • Follow the Chris Beams style for commit messages.
  • Every pull request should answer:
    • What changed?
    • Why?
    • Breaking changes?
    • Server PR (if the change requires a coordinated server update)
  • Comments should be complete sentences and end with a period.

Review Checklist

  • ./gradlew spotlessCheck must pass.
  • All tests from ./gradlew test must succeed.
  • Add new tests for any new feature or bug fix.
  • Update documentation for user facing changes.

For more details see CONTRIBUTING.md in the repository root.