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
+5
Original file line number
Diff line number
Diff line change
@@ -48,6 +48,11 @@ Our work is done directly on Github and PR's are sent to the GitHub repo by core
48
48
49
49
## Setting up for local development
50
50
51
+
The recommended version of Node JS to work with this project is [`16.19.0`](https://nodejs.org/en/blog/release/v16.19.0/) with Yarn version [`1.22.x`](https://github.com/yarnpkg/yarn/blob/master/CHANGELOG.md).
52
+
53
+
> Note: newer versions of Yarn (2+) remove support for lerna's `--mutex` flag
54
+
> so be sure to use Yarn v1.22.x
55
+
51
56
This section should get you running with **Amplify JS** and get you familiar with the basics of the codebase. You will need the latest version of [Node.js](https://nodejs.org/en/) on your system and developing locally also requires `yarn` workspaces. You can install it [here](https://classic.yarnpkg.com/en/docs/install#mac-stable).
52
57
53
58
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).
<p>Inherited from <ahref="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<ahref="abstractpredictionsprovider.html#_config">_config</a></p>
1002
1002
<ul>
1003
-
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L7">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:7</a></li>
1003
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L7">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:7</a></li>
1004
1004
</ul>
1005
1005
</aside>
1006
1006
</section>
@@ -1018,7 +1018,7 @@ <h3>configure</h3>
1018
1018
<asideclass="tsd-sources">
1019
1019
<p>Inherited from <ahref="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<ahref="abstractpredictionsprovider.html#configure">configure</a></p>
1020
1020
<ul>
1021
-
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
1021
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
1022
1022
</ul>
1023
1023
</aside>
1024
1024
<h4class="tsd-parameters-title">Parameters</h4>
@@ -1041,7 +1041,7 @@ <h3>convert</h3>
1041
1041
<liclass="tsd-description">
1042
1042
<asideclass="tsd-sources">
1043
1043
<ul>
1044
-
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L21">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:21</a></li>
1044
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L21">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:21</a></li>
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L48">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:48</a></li>
1067
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L48">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:48</a></li>
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L42">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:42</a></li>
1090
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L42">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:42</a></li>
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L17">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:17</a></li>
1114
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L17">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:17</a></li>
<p>Inherited from <ahref="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<ahref="abstractpredictionsprovider.html#getprovidername">getProviderName</a></p>
1131
1131
<ul>
1132
-
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:15</a></li>
1132
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:15</a></li>
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L36">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:36</a></li>
1149
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L36">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:36</a></li>
<p>Inherited from <ahref="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<ahref="abstractpredictionsprovider.html#_config">_config</a></p>
1002
1002
<ul>
1003
-
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L7">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:7</a></li>
1003
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L7">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:7</a></li>
1004
1004
</ul>
1005
1005
</aside>
1006
1006
</section>
@@ -1018,7 +1018,7 @@ <h3>configure</h3>
1018
1018
<asideclass="tsd-sources">
1019
1019
<p>Inherited from <ahref="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<ahref="abstractpredictionsprovider.html#configure">configure</a></p>
1020
1020
<ul>
1021
-
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
1021
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L17">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:17</a></li>
1045
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L17">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:17</a></li>
<p>Inherited from <ahref="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<ahref="abstractpredictionsprovider.html#getprovidername">getProviderName</a></p>
1062
1062
<ul>
1063
-
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:15</a></li>
1063
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:15</a></li>
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L21">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:21</a></li>
1080
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L21">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:21</a></li>
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L50">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:50</a></li>
1103
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L50">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:50</a></li>
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L44">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:44</a></li>
1126
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L44">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:44</a></li>
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/df016d0f8/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L38">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:38</a></li>
1149
+
<li>Defined in <ahref="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L38">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:38</a></li>
0 commit comments