Skip to content

Commit dd10bbf

Browse files
srchaseAllanZhengYP
authored andcommitted
clarify setup steps for using package-generator (#176)
1 parent 587c533 commit dd10bbf

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Please be aware of the following notes prior to opening a pull request:
6565
SDK's test coverage percentage are unlikely to be merged until tests have
6666
been added.
6767

68-
### Testing
68+
### Setup and Testing
6969

7070
This project uses a monorepo to manage all of the packages.
7171
This allows us to easily test the effects of changes in one package to others.
@@ -92,10 +92,11 @@ The above command will use Lerna to run the `test` script in every package in th
9292

9393
To run the tests for a specific package, you can run `npm test` from within the specified package folder, assuming the above steps have been run.
9494

95-
### Generate Service Clients
95+
### Generating Service Clients
9696

9797
You can generate service client by yourself from either [AWS service models][] or customized models. The SDK provides
98-
a command line interface to make these work easier for you.
98+
a command line interface for generating packages. In order to use the CLI, first complete the test and setup steps (above) to
99+
build the package-generator and its dependencies.
99100

100101
```
101102
node ./packages/package-generator/build/cli.js

0 commit comments

Comments
 (0)