Skip to content

Commit

Permalink
[doc] fixed typos and punctuation (#29225)
Browse files Browse the repository at this point in the history
Fixed typos and added punctuations to improve readability of README.md
files.

---------

Co-authored-by: Maor Leger <maorleger@users.noreply.github.com>
  • Loading branch information
grjan7 and maorleger authored Jun 25, 2024
1 parent 59c7f7d commit e6db98e
Show file tree
Hide file tree
Showing 20 changed files with 303 additions and 247 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ a CLA and decorate the PR appropriately (e.g., status check, comment). Simply fo
provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

# How to contribute to the Azure SDK for Javascript
Expand All @@ -23,7 +23,7 @@ There are many ways that you can contribute to the Azure SDK for JavaScript proj

All code submissions will be reviewed and tested by the team, and those that meet a high bar for both quality and design/roadmap appropriateness will be merged into the source. Be sure to follow the existing file/folder structure when adding new boards or sensors.

If you encounter any bugs with the library please file an issue in the [Issues](https://github.com/Azure/azure-sdk-for-js/issues) section of the project.
If you encounter any bugs with the library, please file an issue in the [Issues](https://github.com/Azure/azure-sdk-for-js/issues) section of the project.

## Things to keep in mind when contributing

Expand All @@ -35,7 +35,7 @@ Some guidance for when you make a contribution:

## Big contributions

If your contribution is significantly big it is better to first check with the project developers in order to make sure the change aligns with the long term plans. This can be done simply by submitting a question via the GitHub Issues section.
If your contribution is significantly big, it is better to first check with the project developers in order to make sure the change aligns with the long term plans. This can be done simply by submitting a question via the GitHub Issues section.

## Project orchestration

Expand Down Expand Up @@ -181,7 +181,7 @@ If you modify the network calls (both the number of calls or their shape) either

Regenerating the recordings has the same requirements as running the live tests. You will be using the same `test` npm script with the environment variables pointing to previously created Azure resources. The only difference is that the `TEST_MODE` environment variable needs to be set to `record`. When this process finishes without errors, the recordings will be updated.

For more information the recorder, please visit the [test-recorder's readme](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/test-utils/recorder/README.md).
For more information about the recorder, please visit the [test-recorder's readme](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/test-utils/recorder/README.md).

Here are a few [Useful Commands](https://github.com/Azure/azure-sdk-for-js/wiki/Golden-Testing-Commands) that can be handy while testing your SDKs.

Expand Down Expand Up @@ -314,7 +314,7 @@ nodeResolve({

### Package Versioning

For information about packages are versioned and tagged see [Javascript Releases](https://azure.github.io/azure-sdk/policies_releases.html#javascript)
For information about packages are versioned and tagged, see [Javascript Releases](https://azure.github.io/azure-sdk/policies_releases.html#javascript)

### Core Client libraries

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Newer versions of these libraries follow the [Azure SDK Design Guidelines for Ty
## Need help?

- For detailed documentation visit our [Azure SDK for JavaScript documentation](https://aka.ms/js-docs)
- For detailed documentation, visit our [Azure SDK for JavaScript documentation](https://aka.ms/js-docs)
- File an issue via [GitHub Issues](https://github.com/Azure/azure-sdk-for-js/issues)
- Check [previous questions](https://stackoverflow.com/questions/tagged/azure-sdk-js) or ask new ones on StackOverflow using `azure-sdk-js` tag.
- Read our [Support documentation](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md).
Expand All @@ -62,6 +62,6 @@ This project welcomes contributions and suggestions. Most contributions require

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2FREADME.png)
6 changes: 3 additions & 3 deletions common/smoke-test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

The Smoke Tests validate customer scenarios by creating an application which
uses package dependencies, loads all packages into a single process, and
executes code samples to ensure basic end to end scenarios work as expected.
executes code samples to ensure basic end-to-end scenarios work as expected.

Smoke Tests are meant to be run periodically in an Azure DevOps pipeline. See
[`smoke-tests.yml`](https://github.com/Azure/azure-sdk-for-js/blob/main/common/smoke-test/smoke-tests.yml) to configure Smoke Tests in an Azure
DevOps pipeline. When run in an Azure DevOps pipeline specify the `-CI` flag to
DevOps pipeline. When run in an Azure DevOps pipeline, specify the `-CI` flag to
ensure environment variables are properly set and error/warning messages are
properly surfaced during the execution.

Expand All @@ -28,7 +28,7 @@ package.

## Configuring Samples

By default _all_ JavaScript samples are prepped, loaded, and executed. Samples
By default, _all_ JavaScript samples are prepped, loaded, and executed. Samples
are assumed to work with just the environment variables defined in
`test-resources.json` for the service. Samples which have additional resource
requirements should opt out of execution.
Expand Down
28 changes: 14 additions & 14 deletions design/modular-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ There are cons to this approach as we consider bringing the JavaScript clients i

## Modular Design

We can create a more ala carte experience where the customer only pulls in the methods they need. With the Azure SDK for JavaScript, we can create a client previously using the `ServiceClient` pattern:
We can create a more a-la-carte experience where the customer only pulls in the methods they need. With the Azure SDK for JavaScript, we can create a client previously using the `ServiceClient` pattern:

```typescript
import { NotificationHubsClient } from "@azure/notification-hubs";
Expand All @@ -40,7 +40,7 @@ const registrationId = await createRegistrationId(context);

The pros of this design are as follows:

- Fine grained exports to only give the customer what they need
- Fine-grained exports to only give the customer what they need
- Smaller bundle sizes the customer for exports.
- Tree shaking is easier for bundlers.

Expand All @@ -54,7 +54,7 @@ The goals of enabling both the class based `ServiceClient` and modular developme

- **Do not introduce breaking changes**
- Keep the existing CommonJS compatibility.
- Do not pollute the top level index with all exports, keeping the top level index.ts as is
- Do not pollute the top-level index with all exports, keeping the top-level index.ts as is
- Expose exports at "namespaces" or export subpaths

## Subpath Exports
Expand All @@ -68,7 +68,7 @@ Node added the following support for subpath exports in the following versions:
- `v12.7.0` - Introduce `"exports"` package.json field as a more powerful alternative to the classic `"main"` field
- `v12.0.0` - Add support for ES modules using `.js` file extension via `package.json` `"type"` field.

For subpaths, we can specify the path which is either a path or a wildcard path. Inside the path, we can specify following:
For subpaths, we can specify the path which is either a path or a wildcard path. Inside the path, we can specify the following:

- `types` - The TypeScript types for that path
- `require` - Common JS entry point
Expand All @@ -94,7 +94,7 @@ For example, we could have our client and associated methods exposed as `@azure/
},
```

Then we could import those modules as the following:
Then, we could import those modules as the following:

```typescript
import { createClientContext, createOrUpdateInstallation } from "@azure/notification-hubs/api";
Expand All @@ -115,7 +115,7 @@ Note the main exports of `.` can expose both ES-Modules and CommonJS such as the

This approach has a number of benefits:

- Does not pollute the top level index to export the world.
- Does not pollute the top-level index to export the world.
- Can support both class-based `ServiceClient` and modular development separately.
- Allows the SDK Team to ship experimental/beta features through its own subpath.

Expand All @@ -133,7 +133,7 @@ First and foremost, we do not want to break the customers so they can continue t

The standard for Azure SDKs going forward is the following:

- `.` - Still expose all things at the top level exports for CommonJS and ES-Modules.
- `.` - Still expose all things at the top-level exports for CommonJS and ES-Modules.
- `/api` - The client context and single method exports
- `/models` - The models and factories

Expand Down Expand Up @@ -171,7 +171,7 @@ This could then be imported such as the following:
import { createClient, createOrUpdateInstallation } from "@azure/notification-hubs/api";
```

For models and their associated factory functions should be in a `models` subpath. The models are then exported via the `models/index.js` file.
Models and their associated factory functions should be in a `models` subpath. The models are then exported via the `models/index.js` file.

```json
"./models": {
Expand All @@ -188,7 +188,7 @@ import { Installation, createAppleInstallation } from "@azure/notification-hubs/

## Shipping Experimental Features

Another aspect of this design is to allow us to ship experimental features with modular development. We can ship preview features in either `experimental` or `preview` subpath exports which allow us to ship features that do not collide with our top level exports nor our standard APIs. Once these features have been approved for GA, they will be removed from the `experimental` or `preview` subpath.
Another aspect of this design is to allow us to ship experimental features with modular development. We can ship preview features in either `experimental` or `preview` subpath exports which allow us to ship features that do not collide with our top-level exports nor our standard APIs. Once these features have been approved for GA, they will be removed from the `experimental` or `preview` subpath.

## Onboarding Azure SDK Packages to Subpath Exports

Expand All @@ -214,7 +214,7 @@ To support subpath exports, the `package.json` requires the following changes.
],
```

- The `exports` must be specified for the top level export as well as subpaths. Wildcards or absolute paths can be specified.
- The `exports` must be specified for the top-level export as well as subpaths. Wildcards or absolute paths can be specified.

```json
"exports": {
Expand All @@ -240,7 +240,7 @@ The TypeScript configuration `tsconfig.json` must also be updated with the follo

- Update the `module` setting to either `NodeNext` or `Node16`.
- Update the `moduleResolution` setting to either `NodeNext` or `Node16`.
- In some cases,the compiler needed `rootDir` set, so update `rootDir` to be `"."`.
- In some cases, the compiler needed `rootDir` set, so update `rootDir` to be `"."`.

### Source Code Changes

Expand All @@ -252,7 +252,7 @@ Previously, we imported files such as the following:
import { isDefined } from "./utils";
```

And now we must specify the `.js` extension.
And now, we must specify the `.js` extension.

```typescript
import { isDefined } from "./utils.js";
Expand All @@ -264,7 +264,7 @@ To support this in our packages, we should think about how we support a hybrid p

### Hybrid Design

For design considerations and code re-use, we could deploy a hybrid solution to this problem by using the single method exports and still expose the existing `ServiceClient` which simply acts as a proxy to the the underlying method.
For design considerations and code re-use, we could deploy a hybrid solution to this problem by using the single method exports and still expose the existing `ServiceClient` which simply acts as a proxy to the underlying method.

```typescript
import { NotificationHubsClientContext, createClientContext, createRegistrationId } from "@azure/notification-hubs/api";
Expand All @@ -284,7 +284,7 @@ export class NotificationHubsServiceClient {

## Follow On Work

With this approach the following functions still work as expected:
With this approach, the following functions still work as expected:

- CI
- Linting
Expand Down
Loading

0 comments on commit e6db98e

Please sign in to comment.