This folder contains documentation for developers of SDKs: internal teams at Microsoft, or advanced contributors.
- Developer Set-Up - How to create a development environment for this repo
- Release - How to release a package when ready
- Packaging - How to organize packaging information for packages under
azure - Changelog - How to document package changes using Chronus (for packages with
pyproject.toml) - Package Versioning - Version numbering rules
- Testing - How to write unit and functional tests for a library
- Advanced Testing - Advanced testing topics
- Performance Testing - How to write and run perf tests
- Recording Migration Guide - Migrating test recordings
- CredScan Process - Credential scanning
- Docstrings - How to document an SDK (API View) and our documentation at MS Learn and the azure.github.io site
- Type Hints and Type Checking / Cheatsheet - How to add type hints and run type checking
- Pylint - Pylint checking guidance
- Sample Guide - How to write SDK samples
- Code Snippets - How to include code snippets in docs
- Common Issues and FAQ - Common SDK issues and how to resolve them
- Test Proxy Troubleshooting - Test proxy issues
- Debug Guide - Debugging tips
- Resolve Issues Effectively - How to triage and resolve customer issues
- Find SDK in CLI Command - Mapping CLI commands to SDK packages
- Dataplane SDK Generation - Generate a dataplane SDK from a TypeSpec definition
- Management Plane - Management plane SDK documentation
- Customize Long Running Operations - LRO customization
- AI Prompt Workflow - Using AI agents for SDK development
- TypeSpec Generation with AI - AI-assisted TypeSpec generation
- Conda Builds - Conda packaging
- Conda Release - Conda release process
- Conda Dev Release - Conda dev release process