Skip to content

Commit 9e738ba

Browse files
committed
Add steps on how to get started
1 parent 5494b55 commit 9e738ba

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/CONTRIBUTING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Please review this document to help to streamline the process and save everyone'
44

55
This repo uses nodejs, so you should install `nodejs` as the package manager. See [installation guide](https://nodejs.org/en/).
66

7-
# Guidelines for contributions we welcome
7+
# Guidelines for contributions that we welcome
88

99
Not all changes are wanted, so on occasion we might close a PR without merging it. We will give you feedback why we can't accept your changes and we'll be nice about it, thanking you for spending your valuable time.
1010

@@ -47,6 +47,13 @@ The UI Library components are [web components](https://developer.mozilla.org/en-
4747

4848
Using Typescript is mandatory when contributing to this repository, although it is not necessary to use it when consuming the components.
4949

50+
### How to get started
51+
52+
1. Make sure you have the recommended version of node.js and npm installed
53+
1. Currently we use node.js v16 and npm v8
54+
2. Run `npm install`
55+
3. Run `npm run storybook` to start the storybook server, which we also use for development
56+
5057
### New component
5158

5259
You can create a new component and that way contribute to the UI library. But before you do that, go to the [`./src/components`](https://github.com/umbraco/Umbraco.UI/tree/dev/src/components) and check if it's not already there. Components from that folder are very much WIP will be gradually moved to packages. You may also look for an inspiration in this [components list](COMPONENTS.md), where you can check what component is in what stage.

0 commit comments

Comments
 (0)