Skip to content

Commit 1abe4c2

Browse files
dougmacknzsapegin
authored andcommitted
Docs: Update introductions for compiling and starting server to separate terminals (styleguidist#1306)
Closes styleguidist#1303
1 parent 4459311 commit 1abe4c2

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

.github/Contributing.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,16 @@ If you want to contribute but don’t know what to do, take a look at these two
1414

1515
## Development workflow
1616

17-
Run Babel in watch mode and start example style guide:
17+
Run Babel in watch mode:
1818

1919
```bash
20-
npm run compile:watch & npm start
20+
npm run compile:watch
21+
```
22+
23+
Then open a new terminal and start an example style guide:
24+
25+
```bash
26+
npm start
2127
```
2228

2329
Open [localhost:6060](http://localhost:6060) in a browser.
@@ -54,13 +60,19 @@ First install dependencies:
5460
npm run test:cypress:pre
5561
```
5662

57-
Then start Styleguidist server:
63+
Then run Babel in watch mode:
64+
65+
```bash
66+
npm run compile:watch
67+
```
68+
69+
Then open a new terminal and start Styleguidist server:
5870

5971
```bash
60-
npm run compile:watch & npm run test:cypress:startServer
72+
npm run test:cypress:startServer
6173
```
6274

63-
And, finally, in a separate terminal run tests:
75+
And, finally, in another separate terminal run tests:
6476

6577
```bash
6678
npm run test:cypress:run
@@ -78,11 +90,11 @@ npm run test:cypress:open
7890
- We’re using [Prettier](https://github.com/prettier/prettier) to format JavaScript, so don’t worry much about code formatting.
7991
- Don’t commit generated files, like minified JavaScript.
8092
- Don’t change version number and change log.
81-
- If you're updating examples other then `examples/basic`, you'll need to modify your watch and start commands:
93+
- If you're updating examples other then `examples/basic`, you'll need to modify your start commands:
8294

8395
```bash
84-
npm run compile:watch & npm run start:customised # if making changes to examples/customised
85-
npm run compile:watch & npm run start:sections # if making changes to examples/sections
96+
npm run start:customised # if making changes to examples/customised
97+
npm run start:sections # if making changes to examples/sections
8698
```
8799

88100
See the `scripts` section of the top level [package.json](https://github.com/styleguidist/react-styleguidist/blob/master/package.json#L135)

0 commit comments

Comments
 (0)