Skip to content

Commit 4c1232f

Browse files
Update README.md
1 parent e17239e commit 4c1232f

File tree

1 file changed

+0
-29
lines changed

1 file changed

+0
-29
lines changed

README.md

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -22,32 +22,3 @@ import { Alert } from "@code4rena/components-library";
2222
2323
<Alert {...args} />
2424
```
25-
26-
## Run Storybook
27-
Storybook will run on [http://localhost:6006](http://localhost:6006)
28-
29-
```
30-
npm run storybook
31-
```
32-
OR
33-
```
34-
yarn storybook
35-
```
36-
37-
### Storybook Actions
38-
If you want to make use of [Storybook actions](https://storybook.js.org/docs/angular/essentials/actions) for a specific component, please refer to the `Button.stories.tsx` file. The recommendation is to pass the event handler function directly to the Story component as opposed to passing it through _ComponentName.args_. Passing the event handler function through the **args** parameter may not log the event in the `Actions` tab of the Story's dashboard.
39-
40-
## Testing
41-
For testing, we are using [Jest](https://jestjs.io/docs/getting-started) and [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/).
42-
43-
To maintain the standards, test files should be named `componentName.test.tsx` and be placed inside the component folder for which the test relates to.
44-
45-
## Publishing to NPM
46-
47-
A GitHub Action has been developed to help automate package releases. All that you will need to do is:
48-
49-
1. Make sure to increase the `version` field in the **package.json**
50-
2. On the GitHub repo's home page, navigate to the righthand side and click on **Create a new release**
51-
3. Give the release a `title` and `description` outlining the changes made in the release
52-
4. Choose/Create a **tag** corresponding to the new version that was added in the package.json in **step 1**
53-
5. Once the details are filled out, submit the release. You will get taken to a confirmation page. This process will automatically trigger the GitHub action that will publish the package to npm.

0 commit comments

Comments
 (0)