Writing Excellent Samples

We generally write two types of samples for Azure SDK for JS client packages:

• Client samples that demonstrate a single method or concept of a client API.
• End-to-end (or integration) samples that demonstrate how a client API may be used with another client, framework, or service.

This page focuses on client samples, since we have more tooling and conventions related to them, but a brief section on integration samples follows at the end of the page.

Client Samples

Integration Samples

We typically do not store end-to-end samples in this repo. We avoid doing so for a handful of reasons:

• End-to-end samples often require their own setup. A sample that demonstrates using Azure Storage in a React app may require its own package.json file, build instructions, development tools, etc.
• End-to-end samples usually consist of multiple files