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: README.md
+9-2Lines changed: 9 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ This repository is a monorepo that we manage using [Lerna](https://lernajs.io/).
11
11
## Local development
12
12
13
13
1. Run `yarn` in the root directory
14
-
1. Run `yarn build-all`
14
+
1. Run `yarn build`
15
15
16
16
### Publishing Modules
17
17
@@ -54,6 +54,14 @@ We do that using symlinks (the following instructions assume you have set up and
54
54
1. Send a `feat` PR adding that package
55
55
1. One merged, message out in our #frontend Slack channel to other client-modules developers to re-run `yarn lerna bootstrap` after they merge from `main`
56
56
57
+
**Turborepo**
58
+
59
+
This monorepo uses [Turborepo](https://turborepo.org/) to cache previous builds locally and in CI.
60
+
61
+
The config for Turborepo is located at [/turbo.json](/turbo.json).
62
+
63
+
To use Turborepo without extra configuration, if your package needs to be compiled, it should have a task called `build` that compiles it's files and puts them into a directory called `dist` inside the package directory. If you need a more complicated setup, you can read the docs and customize the configuration in `turbo.json`.
64
+
57
65
### PR Title Guide
58
66
59
67
Your PR Title should follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) Format.
@@ -152,4 +160,3 @@ Optional extra description for your changes.
152
160
This goes in the description for your PR, between the `<!--- CHANGELOG-DESCRIPTION -->` comment tags in the PR template.
153
161
154
162
If you include the text `BREAKING CHANGE:` in your description it will trigger a major version bump. We prefer to use the `feat!:` syntax for breaking changes described above.
0 commit comments