You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+15-15
Original file line number
Diff line number
Diff line change
@@ -53,12 +53,12 @@ This section should get you running with **Amplify JS** and get you familiar wit
53
53
Start by [forking](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the main branch of [amplify-js](https://github.com/aws-amplify/amplify-js).
> Note: Make sure to always [sync your fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork) with main branch of `amplify-js`
@@ -82,14 +82,14 @@ Amplify JS is a monorepo built with `Yarn` and `Lerna`. All the categories of Am
82
82
#### Build step:
83
83
84
84
```
85
-
$ yarn build --scope @aws-amplify/auth
85
+
yarn build --scope @aws-amplify/auth
86
86
```
87
87
88
88
#### Testing:
89
89
90
90
```
91
-
$ yarn run test --scope @aws-amplify/auth
92
-
$ yarn run test --scope @aws-amplify/ui-components
91
+
yarn run test --scope @aws-amplify/auth
92
+
yarn run test --scope @aws-amplify/ui-components
93
93
```
94
94
95
95
> Note: There is a commit hook that will run the tests prior to committing. Please make sure if you are going to provide a pull request to be sure you include unit tests with your functionality and that all tests pass.
@@ -102,22 +102,22 @@ The best way to develop locally and test is to link the individual package you
102
102
Run watch mode while editing (auth for example):
103
103
104
104
```
105
-
$ npx lerna exec --scope @aws-amplify/auth yarn link
Or run the whole library in watch mode if you are working on multiple packages
110
110
111
111
```
112
-
$ yarn build # Build the whole library
113
-
$ yarn link-all # Make all the packages available to link
114
-
$ yarn build:esm:watch # All packages are building ES6 modules in watch mode
112
+
yarn build # Build the whole library
113
+
yarn link-all # Make all the packages available to link
114
+
yarn build:esm:watch # All packages are building ES6 modules in watch mode
115
115
```
116
116
117
117
In your sample project, you can now link specific packages
118
118
119
119
```
120
-
$ yarn link @aws-amplify/auth
120
+
yarn link @aws-amplify/auth
121
121
```
122
122
123
123
These tests are only necessary if you’re looking to contribute a Pull Request. If you’re just playing locally you don’t need them. However if you’re contributing a Pull Request for anything other than bug fixes it would be best to validate that first because depending on the scope of the change.
@@ -130,7 +130,7 @@ To publish in Verdaccio, start a Verdaccio instance and then,
0 commit comments