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
+7-7
Original file line number
Diff line number
Diff line change
@@ -26,32 +26,32 @@
26
26
27
27
### Creating new packages
28
28
29
-
We use use [Plop](https://plopjs.com/) to create scripts that help you to scaffold new packages. In the root of the repo, you can run `yarn generate`. Then follow the steps in the CLI. Plop will generate the relevant files and add the relevant imports and exports to the main `src/index.ts` file required to make the component available when publishing the library. Read more about [contribution to Forma 36](https://f36.contentful.com/introduction/contributing).
29
+
We use use [Plop](https://plopjs.com/) to create scripts that help you to scaffold new packages. In the root of the repo, you can run `npm run-script generate`. Then follow the steps in the CLI. Plop will generate the relevant files and add the relevant imports and exports to the main `src/index.ts` file required to make the component available when publishing the library. Read more about [contribution to Forma 36](https://f36.contentful.com/introduction/contributing).
30
30
31
31
## Development
32
32
33
-
For local development, in the root of the repo run `yarn` to install all dependencies and then `yarn build` to build all packages. Now follow the instructions of the specific package you’re working on.
33
+
For local development, in the root of the repo run `npm i` to install all dependencies and then `npm run-script build` to build all packages. Now follow the instructions of the specific package you’re working on.
34
34
You will find each package’s instructions in their README files, check the [Packages](#packages) section for a list of all packages.
35
35
36
36
> In case you are having problems to install the dependencies, try using NVM to get the same node version we use by running `nvm use` in the root of the repo
37
37
38
38
### Storybook for f36-components
39
39
40
-
We use storybook with our react component library to develop components. You can start it from the root of the repo, just run `yarn storybook`
40
+
We use storybook with our react component library to develop components. You can start it from the root of the repo, just run `npm run-script storybook`
41
41
42
42
## Commits & releases
43
43
44
-
Use `yarn commit`. This uses the [Commitzen](https://github.com/commitizen/cz-cli) CLI to create a conventional commit message based on your changes. CI is setup to release all new commits on the main branch that contains a new [changeset](https://github.com/changesets/changesets).
44
+
Use `npm run-script commit`. This uses the [Commitzen](https://github.com/commitizen/cz-cli) CLI to create a conventional commit message based on your changes. CI is setup to release all new commits on the main branch that contains a new [changeset](https://github.com/changesets/changesets).
45
45
46
46
Read more about changeset [here](RELEASES.md)
47
47
48
48
## Testing with your own project locally
49
49
50
50
You can test changes to a package of this monorepo in your own project locally by taking the following steps:
51
51
52
-
1. Run `yarn build` in the desired package's directory to ensure your latest changes have been built
53
-
2. Run `yarn link` in the desired package's directory
54
-
3. Change to your local project's directory and run `yarn link NAME_OF_PACKAGE` to link to the local version of the package (e.g. `yarn link @contentful/f36-components`)
52
+
1. Run `npm run-script build` in the desired package's directory to ensure your latest changes have been built
53
+
2. Run `npm link` in the desired package's directory
54
+
3. Change to your local project's directory and run `npm link NAME_OF_PACKAGE` to link to the local version of the package (e.g. `npm link @contentful/f36-components`)
Copy file name to clipboardexpand all lines: RELEASES.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ But in case you want a new version to be published, you will need to add a chang
13
13
14
14
### Through CLI
15
15
16
-
- run `yarn changeset` on the root of the repository.
16
+
- run `npm run-script changeset` on the root of the repository.
17
17
- it starts a wizard showing packages that had changes from `main` branch, and which kind of bump should be applied (major, minor or patch), and also ask for a description of the change.
18
18
- it creates a file in the `.changeset` folder that needs to be commited to the branch.
19
19
-`changeset-bot` will show that information in its comment on the PR.
0 commit comments