Contributor Guides
April 23, 2026 · View on GitHub
This directory contains guides for developers building or maintaining Azure SDK for Java libraries.
If you are a consumer of the SDK looking for usage guidance, start at the User Guide Index instead.
Quick Start
- Set up your environment → Getting Started
- Build the repo → Building
- Run tests → Unit Testing | Live Testing
- Check code quality → Code Quality
- Submit a PR → CONTRIBUTING.md
All Guides
| Guide | Description |
|---|---|
| Getting Started | Install Java, Maven, configure Git; IDE recommendations |
| Building | mvn commands to build, test, and generate reports |
| Unit Testing | Mocking best practices, test parallelization, remote debugging |
| Live Testing | Deploy Azure test resources and run integration tests |
| Code Quality | CheckStyle, SpotBugs, Revapi, JaCoCo |
| Versioning | version_client.txt, dependency tags, incrementing versions |
| Adding a Module | Create a new SDK module: dir structure, POM, versioning, CODEOWNERS |
| TypeSpec Quickstart | End-to-end workflow: generate → build → test → release |
| Working with AutoRest | OpenAPI 2.0 / Swagger code generation options |
| Writing Performance Tests | Set up and run perf-test-core benchmarks |
| JavaDoc & Code Snippets | Javadoc standards and codesnippet-maven-plugin workflow |
| Access Helpers | Cross-package internal access without public APIs |
| BOM Guidelines | How the Azure SDK BOM is structured, released, and validated |
| Deprecation Process | Steps to mark a library deprecated and publish a final release |
| Release Checklist | What to do before Beta 1, Beta N, and GA |
| Credential Scan | Monitor and suppress CredScan warnings |
| SDK Generation Troubleshooting | Diagnose auto-generation pipeline failures |
| TypeSpec Client Customizations | TypeSpec client.tsp reference |
External References
- Azure SDK Design Guidelines for Java
- CONTRIBUTING.md — PR rules, merge conventions, versioning policy