Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add development instructions to contributing.md #3633

Merged
merged 2 commits into from
Aug 10, 2020
Merged

docs: add development instructions to contributing.md #3633

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ba56b6
add development instructions to contributing.md
Aug 3, 2020
734c4b5
Merge branch 'master' into users/dlesaca/update-contributing-doc
awentzel Aug 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ Now that your machine is setup, you can clone the FAST repository. Open a termin
```shell
git clone https://github.com/microsoft/fast.git
```
Cloning via SSH:

```shell
git clone git@github.com:microsoft/fast.git
```

### Installing and building

Expand All @@ -48,6 +53,15 @@ After the initial install, you can re-build all workspaces in the future with:
lerna run prepare
```

### Developing in `fast-components`
If you're interested in contributing changes to the `fast-component` design system start by navigating to the `fast-components` directory and starting the Storybook local server there.

```bash
cd packages/web-components/fast-components
yarn start
```
Storybook will automatically open in a browser window at `localhost:6006`.

### Testing

To run all tests for all packages, use the following command:
Expand Down