5ce0c303df | ||
---|---|---|
.. | ||
customize_code | ||
find_sdk | ||
issues | ||
mgmt | ||
package_version | ||
private_package | ||
README.md | ||
code_snippets.md | ||
conda-builds.md | ||
credscan_process.md | ||
customize_long_running_operation.md | ||
debug_guide.md | ||
debug_guide_example.png | ||
debug_guide_position.png | ||
dev_setup.md | ||
docstring.md | ||
engineering_assumptions.md | ||
how_to_request_a_feature_in_sdk.md | ||
packaging.md | ||
perfstress_tests.md | ||
pylint_checking.md | ||
recording_migration_guide.md | ||
release.md | ||
release_stage.png | ||
sample_guide.md | ||
static_type_checking.md | ||
static_type_checking_cheat_sheet.md | ||
test_proxy_migration_guide.md | ||
test_proxy_troubleshooting.md | ||
tests-advanced.md | ||
tests.md |
README.md
Developer Documentation
This folder contains documentation for developers of SDKs: internal teams at Microsoft, or advanced contributors.
Overview of the documents:
- 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
- Testing: How to write unit and functional tests for a library
- Docstrings: How to document an SDK (API View) and our documentation at MS Docs and the azure.github.io site.
- Type Hints and Type Checking / Cheatsheet: How to add type hints to your library code and run type checking.
The mgmt folder contains information specific to management packages (i.e. packages prefixed by azure-mgmt
)