Merge pull request #5702 from gaearon/patch-3

Mention that Jest can be used directly in Contributing
facebook · Dec 21, 2015 · dae1152 · dae1152
2 parents 8d0efaf + ca31e9f
commit dae1152
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,6 +14,14 @@ Some of the core team will be working directly on GitHub. These changes will be
 
 We will do our best to keep `master` in good shape, with tests passing at all times. But in order to move fast, we will make API changes that your application might not be compatible with. We will do our best to communicate these changes and always version appropriately so you can lock into a specific version if need be.
 
+### Test Suite
+
+Use `grunt test` to run the full test suite with PhantomJS.
+
+This command is just a facade to [Jest](https://facebook.github.io/jest/). You may optionally `npm install -g jest-cli` run and use Jest commands directly to have more control over how tests are executed.
+
+For example, `jest --watch` lets you automatically run the test suite on every file change.
+
 ### Pull Requests
 
 The core team will be monitoring for pull requests. When we get one, we'll run some Facebook-specific integration tests on it first. From here, we'll need to get another person to sign off on the changes and then merge the pull request. For API changes we may need to fix internal uses, which could cause some delay. We'll do our best to provide updates and feedback throughout the process.

diff --git a/README.md b/README.md
@@ -84,8 +84,6 @@ We use grunt to automate many tasks. Run `grunt -h` to see a mostly complete lis
 ```sh
 # Build and run tests with PhantomJS
 grunt test
-# Build and run tests in your browser
-grunt test --debug
 # Lint the code with ESLint
 grunt lint
 # Wipe out build directory