Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 19 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
* [Contributor License Agreements](#contributor-license-agreements)
* [Contributing a patch](#contributing-a-patch)
* [Running the tests](#running-the-tests)
* [Releasing the library](#releasing-the-library)

## Contributor License Agreements

Expand All @@ -15,46 +14,46 @@ have to jump a couple of legal hurdles.
Please fill out either the individual or corporate Contributor License Agreement
(CLA).

* If you are an individual writing original source code and you're sure you
own the intellectual property, then you'll need to sign an [individual CLA](https://developers.google.com/open-source/cla/individual).
* If you work for a company that wants to allow you to contribute your work,
then you'll need to sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate).
* If you are an individual writing original source code and you're sure you
own the intellectual property, then you'll need to sign an [individual CLA](https://developers.google.com/open-source/cla/individual).
* If you work for a company that wants to allow you to contribute your work,
then you'll need to sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate).

Follow either of the two links above to access the appropriate CLA and
instructions for how to sign and return it. Once we receive it, we'll be able to
accept your pull requests.

## Contributing A Patch

1. Submit an issue describing your proposed change to the repo in question.
1. The repo owner will respond to your issue promptly.
1. If your proposed change is accepted, and you haven't already done so, sign a
Contributor License Agreement (see details above).
1. Fork the desired repo, develop and test your code changes.
1. Ensure that your code adheres to the existing style in the code to which
you are contributing.
1. Ensure that your code has an appropriate set of tests which all pass.
1. Title your pull request following [Conventional Commits](https://www.conventionalcommits.org/) styling.
1. Submit a pull request.
1. Submit an issue describing your proposed change to the repo in question.
2. The repo owner will respond to your issue promptly.
3. If your proposed change is accepted, and you haven't already done so, sign a
Contributor License Agreement (see details above).
4. Fork the desired repo, develop and test your code changes.
5. Ensure that your code adheres to the existing style in the code to which
you are contributing.
6. Ensure that your code has an appropriate set of tests which all pass.
7. Title your pull request following [Conventional Commits](https://www.conventionalcommits.org/) styling.
8. Submit a pull request.

## Running the tests

1. [Prepare your environment for Node.js setup][setup].
1. [Prepare your environment for Node.js setup][setup].

1. Install dependencies:
2. Install dependencies:

npm install

1. Run the tests:
3. Run the tests:

# Run unit tests.
npm test

# Run lint check.
npm run lint

1. Lint (and maybe fix) any changes:
4. Lint (and maybe fix) any changes:

npm run format

[setup]: https://cloud.google.com/nodejs/docs/setup
[setup]: https://cloud.google.com/nodejs/docs/setup
3 changes: 1 addition & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,7 @@ export interface LoaderOptions {
* browser's language setting, you can force it to display information in a
* particular language when loading the Maps JavaScript API code.
*
* For example, the following example localizes the language to the United
* Kingdom:
* For example, the following example localizes the language to Japan:
*
* ```
* const loader = Loader({apiKey, language: 'ja', region: 'JP'});
Expand Down