Add AGENTS.md (#2527)

Add AGENTS.md

Author: Quinn-With-Two-Ns

AGENTS.md

@@ -0,0 +1,58 @@
+# 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:
+   ```bash
+   ./gradlew --offline spotlessApply
+   ```
+2. Run the tests. This can take a long time so you may prefer to run individual tests.
+   ```bash
+   ./gradlew test
+   ```
+   To run only the core SDK tests or a single test:
+   ```bash
+   ./gradlew :temporal-sdk:test --offline --tests "io.temporal.workflow.*"
+   ./gradlew :temporal-sdk:test --offline --tests "<package.ClassName>"
+   ```
+3. Build the project:
+   ```bash
+   ./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](http://chris.beams.io/posts/git-commit/) 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.

temporal-kotlin/AGENTS.md

@@ -0,0 +1 @@
+Unlike the rest of this repository, this directory is for the Kotlin SDK so most of the code here is written in Kotlin, not Java.

temporal-sdk/AGENTS.md

@@ -0,0 +1,7 @@
+This directory contains the core Temporal SDK code, which is used to build Temporal applications. The SDK provides a set of APIs and libraries that allow developers to create, manage, and execute workflows and activities in a distributed environment. The SDK is designed to be easy to use and provides a high-level abstraction over the underlying Temporal service.
+
+The SDK is written in Java and is designed to be used with the Temporal service. It provides a set of APIs for defining workflows and activities, as well as for managing the execution of those workflows and activities.
+
+# Testing
+
+All tests are written using JUnit4.

temporal-sdk/src/main/java/io/temporal/internal/AGENTS.md

@@ -0,0 +1 @@
+All files in this directory and subdirectory are intended to be internal to the SDK and should not be used by external users. They do not have the same backwards compatibility guarantees as our other APIS

temporal-sdk/src/test/java/io/temporal/workflow/AGENTS.md

@@ -0,0 +1,7 @@
+# Summary
+
+This directory and sub directory contain tests for workflow APIs.
+
+# Testing
+
+Tests should use the `SDKTestWorkflowRule` to create a worker, register workflows, activities and nexus services.