Skip to content

Commit 054f9ab

Browse files
authored
Provide more clarity on development basic commands (github#17423)
1 parent c51f539 commit 054f9ab

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

contributing/development.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Once you've installed Node.js (which includes the popular `npm` package manager)
1515
```sh
1616
git clone https://github.com/github/docs
1717
cd docs
18-
npm install
18+
npm ci
1919
npm run build
2020
npm start
2121
```
@@ -24,7 +24,9 @@ You should now have a running server! Visit [localhost:4000](http://localhost:40
2424

2525
When you're ready to stop your local server, type <kbd>CTRL</kbd><kbd>c</kbd> in your terminal window.
2626

27-
Note that `npm run build` is a one-time step that create static assets.
27+
Note that `npm ci` and `npm run build` are steps that should typically only need to be run once each time you pull the latest for a branch.
28+
- `npm ci` does a clean install of dependencies, without updating the `package-lock.json` file
29+
- `npm run build` creates static assets, such as the `dist/index.js` and `dist/index.css` files
2830

2931
### Using GitHub Codespaces
3032

0 commit comments

Comments
 (0)