Skip to content

Commit 7d3b66f

Browse files
authored
fix: minor contributing doc fixes (#8358)
* make it easier to copy/paste commands by removing unecessary `$` * replace deprecated `--skip-git` param with `--no-git-tag-version --no-push`
1 parent 94f25ec commit 7d3b66f

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

CONTRIBUTING.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@ This section should get you running with **Amplify JS** and get you familiar wit
5353
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).
5454

5555
```
56-
$ git clone git@github.com:[username]/amplify-js.git
57-
$ cd amplify-js
56+
git clone git@github.com:[username]/amplify-js.git
57+
cd amplify-js
5858
59-
$ yarn
60-
$ yarn bootstrap
61-
$ yarn build
59+
yarn
60+
yarn bootstrap
61+
yarn build
6262
```
6363

6464
> 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
8282
#### Build step:
8383

8484
```
85-
$ yarn build --scope @aws-amplify/auth
85+
yarn build --scope @aws-amplify/auth
8686
```
8787

8888
#### Testing:
8989

9090
```
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
9393
```
9494

9595
> 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
102102
Run watch mode while editing (auth for example):
103103

104104
```
105-
$ npx lerna exec --scope @aws-amplify/auth yarn link
106-
$ npx lerna exec --scope @aws-amplify/auth yarn build:esm:watch
105+
npx lerna exec --scope @aws-amplify/auth yarn link
106+
npx lerna exec --scope @aws-amplify/auth yarn build:esm:watch
107107
```
108108

109109
Or run the whole library in watch mode if you are working on multiple packages
110110

111111
```
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
115115
```
116116

117117
In your sample project, you can now link specific packages
118118

119119
```
120-
$ yarn link @aws-amplify/auth
120+
yarn link @aws-amplify/auth
121121
```
122122

123123
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,
130130

131131
```
132132
yarn config set registry http://localhost:4873/
133-
yarn lerna publish --skip-git --force-publish
133+
yarn lerna publish --no-git-tag-version --no-push --force-publish
134134
```
135135

136136
To publish a local version of a specific package,

0 commit comments

Comments
 (0)