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

Jump to bottom

Docs: Reorganized to avoid misunderstandings. #9434

Merged
merged 1 commit into from Oct 14, 2017
Merged

Docs: Reorganized to avoid misunderstandings. #9434

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 12 additions & 15 deletions docs/developer-guide/development-environment.md
View file
Open in desktop
Expand Up @@ -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:

Expand All @@ -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:

Expand All @@ -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.