Skip to content

Commit dae1152

Browse files
committed
Merge pull request #5702 from gaearon/patch-3
Mention that Jest can be used directly in Contributing
2 parents 8d0efaf + ca31e9f commit dae1152

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ Some of the core team will be working directly on GitHub. These changes will be
1414

1515
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.
1616

17+
### Test Suite
18+
19+
Use `grunt test` to run the full test suite with PhantomJS.
20+
21+
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.
22+
23+
For example, `jest --watch` lets you automatically run the test suite on every file change.
24+
1725
### Pull Requests
1826

1927
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.

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,6 @@ We use grunt to automate many tasks. Run `grunt -h` to see a mostly complete lis
8484
```sh
8585
# Build and run tests with PhantomJS
8686
grunt test
87-
# Build and run tests in your browser
88-
grunt test --debug
8987
# Lint the code with ESLint
9088
grunt lint
9189
# Wipe out build directory

0 commit comments

Comments
 (0)