From 054f9abc737948a364af8c7f9e0572e120d8717f Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Thu, 21 Jan 2021 12:42:38 -0600 Subject: [PATCH] Provide more clarity on development basic commands (#17423) --- contributing/development.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/contributing/development.md b/contributing/development.md index 3187272a29ce..df8644797622 100644 --- a/contributing/development.md +++ b/contributing/development.md @@ -15,7 +15,7 @@ Once you've installed Node.js (which includes the popular `npm` package manager) ```sh git clone https://github.com/github/docs cd docs -npm install +npm ci npm run build npm start ``` @@ -24,7 +24,9 @@ You should now have a running server! Visit [localhost:4000](http://localhost:40 When you're ready to stop your local server, type CTRLc in your terminal window. -Note that `npm run build` is a one-time step that create static assets. +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. + - `npm ci` does a clean install of dependencies, without updating the `package-lock.json` file + - `npm run build` creates static assets, such as the `dist/index.js` and `dist/index.css` files ### Using GitHub Codespaces