From 02732bd4d4ee99f2020f90d845537a752872a2df Mon Sep 17 00:00:00 2001 From: Jonathan Pool Date: Fri, 13 Oct 2017 19:24:51 -0700 Subject: [PATCH] Docs: Reorganized to avoid misunderstandings. (#9434) Original headings made it seem that sections after Step 5 could be additional steps. And summary of workflow without a link to the full workflow could make a reader think that the summary is the whole workflow. --- .../development-environment.md | 27 +++++++++---------- 1 file changed, 12 insertions(+), 15 deletions(-) diff --git a/docs/developer-guide/development-environment.md b/docs/developer-guide/development-environment.md index a6e44941f11..afbab5641a4 100644 --- a/docs/developer-guide/development-environment.md +++ b/docs/developer-guide/development-environment.md @@ -57,11 +57,17 @@ npm test The testing takes a few minutes to complete. If any tests fail, that likely means one or more parts of the environment setup didn't complete correctly. The upstream tests always pass. -## Build Scripts +## Reference Information + +### Workflow + +Once you have your development environment installed, you can make and submit changes to the ESLint source files. Doing this successfully requires careful adherence to our [pull-request submission workflow](contributing/pull-requests.md). + +### Build Scripts ESLint has several build scripts that help with various parts of development. -### npm test +#### npm test The primary script to use is `npm test`, which does several things: @@ -75,19 +81,19 @@ Be sure to run this after making changes and before sending a pull request with **Note:** The full code coverage report is output into `/coverage`. -### npm run lint +#### npm run lint Runs just the JavaScript and JSON linting on the repository -### npm run browserify +#### npm run browserify Generates `build/eslint.js`, a version of ESLint for use in the browser -### npm run docs +#### npm run docs Generates JSDoc documentation and places it into `/jsdoc`. -### npm run profile +#### npm run profile This command is used for intensive profiling of ESLint using Chrome Developer Tools. It starts a development server that runs through three profiles: @@ -101,12 +107,3 @@ Your browser should automatically open to the page in question. When that happen 1. Click on Profiles You should start to see profiles for each run show up on the left side. If not, reload the page in the browser. Once all three profiles have completed, they will be available for inspection. - -## Workflow - -Whenever you make changes to the ESLint source files, you'll need to run `npm test` to rerun the tests. The workflow is: - -1. Make changes -2. Run `npm test` to run tests on the command line - -You'll have to do this each time you make a change. The tests are run automatically whenever a pull request is received, so make sure to verify your changes work before submitting them.