@@ -7,7 +7,6 @@ and pull requests. Please read through this document before submitting any
7
7
issues or pull requests to ensure we have all the necessary information to
8
8
effectively respond to your bug report or contribution.
9
9
10
-
11
10
## Filing Bug Reports
12
11
13
12
You can file bug reports against the SDK on the [ GitHub issues] [ issues ] page.
@@ -41,7 +40,6 @@ guidelines prior to filing a bug report.
41
40
as well, like whether this is a persistent issue, or if it only occurs
42
41
some of the time.
43
42
44
-
45
43
## Submitting Pull Requests
46
44
47
45
We are always happy to receive code and documentation contributions to the SDK.
@@ -57,7 +55,7 @@ Please be aware of the following notes prior to opening a pull request:
57
55
58
56
3 . Wherever possible, pull requests should contain tests as appropriate.
59
57
Bugfixes should contain tests that exercise the corrected behavior (i.e., the
60
- test should fail without the bugfix and pass with it), and new features
58
+ test should fail without the bugfix and pass with it), and new features
61
59
should be accompanied by tests exercising the feature. Pull requests that
62
60
contain failing tests will not be merged until the test failures are addressed.
63
61
Pull requests that cause a significant drop in the SDK's test coverage
@@ -67,10 +65,9 @@ Please be aware of the following notes prior to opening a pull request:
67
65
[ conventional commits] [ conventional commits ] . Title must begin with ` feat(module): title ` ,
68
66
` fix(module): title ` , ` docs(module): title ` , ` test(module): title ` , ` chore(module): title ` .
69
67
Title should be lowercase and not period at the end of it. If the commit includes
70
- a breaking change, the commit message must end with a single paragraph: `BREAKING
71
- CHANGE: a description of what broke`
68
+ a breaking change, the commit message must end with a single paragraph: ` BREAKING CHANGE: a description of what broke `
72
69
73
- 5 . After getting ready to open a pull request, make sure to run the ` npm run update-clients`
70
+ 5 . After getting ready to open a pull request, make sure to run the ` yarn update-clients`
74
71
to re-generate all the service clients, and commit the change(if any) to a
75
72
standalone commit following the guide above.
76
73
@@ -79,32 +76,34 @@ Please be aware of the following notes prior to opening a pull request:
79
76
This project uses a monorepo to manage all of the packages.
80
77
This allows us to easily test the effects of changes in one package to others.
81
78
82
- To run the tests locally, install the dependencies for the root project. This includes Lerna, the tool
83
- we use to manage the monorepo.
79
+ Make sure you have [ ` yarn ` ] ( https://yarnpkg.com/en/ ) installed by:
84
80
85
81
```
86
- npm install
82
+ yarn --version
87
83
```
88
84
89
- Then, run the following command to tell Lerna to install and link any dependencies in the ` packages ` directory:
85
+ If not, please refer to [ yarn installation] ( https://yarnpkg.com/en/docs/install#mac-stable ) to install ` yarn ` .
86
+
87
+ To install the dependencies and link the library, run the following command:
90
88
91
89
```
92
- npm run bootstrap
90
+ yarn
93
91
```
94
92
95
- To run all of the tests in the repository, still from the root package, run the following:
93
+ To run all of the tests in the repository, still from the root package, run the following command :
96
94
97
95
```
98
- npm test
96
+ yarn test-all
99
97
```
98
+
100
99
The above command will use Lerna to run the ` test ` script in every package in the ` packages ` directory.
101
100
102
- 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.
101
+ To run the tests for a specific package, you can run ` yarn test` from within the specified package folder, assuming the above steps have been run.
103
102
104
103
### Generating Service Clients
105
104
106
- You can generate service client by yourself from either [ AWS service models] [ ] or customized models. The SDK provides
107
- a command line interface for generating packages. In order to use the CLI, first complete the test and setup steps (above) to
105
+ You can generate service client by yourself from either [ AWS service models] [ ] or customized models. The SDK provides
106
+ a command line interface for generating packages. In order to use the CLI, first complete the test and setup steps (above) to
108
107
build the package-generator and its dependencies.
109
108
110
109
```
@@ -138,5 +137,5 @@ node ./packages/package-generator/build/cli.js client --model models/dynamodb/20
138
137
[ pr ] : https://github.com/aws/aws-sdk-js-v3/pulls
139
138
[ license ] : http://aws.amazon.com/apache2.0/
140
139
[ cla ] : http://en.wikipedia.org/wiki/Contributor_License_Agreement
141
- [ AWS service models] : https://github.com/aws/aws-sdk-js-v3/tree/master/models
140
+ [ aws service models] : https://github.com/aws/aws-sdk-js-v3/tree/master/models
142
141
[ conventional commits ] : https://www.conventionalcommits.org/
0 commit comments