Skip to content

clarify setup steps for using package-generator #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 25, 2019
Merged

clarify setup steps for using package-generator #176

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Please be aware of the following notes prior to opening a pull request:
SDK's test coverage percentage are unlikely to be merged until tests have
been added.

### Testing
### Setup and Testing

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

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.

### Generate Service Clients
### Generating Service Clients

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

```
node ./packages/package-generator/build/cli.js
Expand Down