From dcbb6c5ce5f41fe193a048847582033be4864245 Mon Sep 17 00:00:00 2001 From: Peeyush Kushwaha Date: Mon, 29 May 2017 20:50:13 +0530 Subject: [PATCH] Add a section on troubleshooting [skip ci] (#5788) * Add a section on troubleshooting [skip ci] * Move troubleshooting section to be under the running tests section * [skip ci] --- CONTRIBUTING.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f979d6d797bd..4ea00201696f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -130,6 +130,18 @@ $ BABEL_ENV=cov make build $ ./scripts/test-cov.sh ``` + +#### Troubleshooting Tests + +In case you're not able to reproduce an error on CI locally, it may be due to + + - Node Version: Travis CI runs the tests against all major node versions. If your tests use JavaScript features unsupported by lower versions of node, then use [minNodeVersion option](#writing-tests) in options.json. + - Timeout: Check the CI log and if the only errors are timeout errors and you are sure that it's not related to the changes you made, ask someone in the slack channel to trigger rebuild on the CI build and it might be resolved + +In case you're locally getting errors which are not on the CI, it may be due to + + - Updates in Dependencies: Make sure you run `make bootstrap` before you run `make build` or `make watch` before you run the tests. + ### Writing tests Most packages in [`/packages`](https://github.com/babel/babel/tree/master/packages) have a `test` folder, however some tests might be in other packages or in [`/packages/babel-core`](https://github.com/babel/babel/tree/master/packages/babel-core/test/fixtures). @@ -235,7 +247,7 @@ To start the debugging in Chrome DevTools, open the given URL. The debugger starts at the first executed line of code, which is Mocha's first line by default. Click _Resume script execution_ Resume script execution button. to jump to the set breakpoint. Note that the code shown in Chrome DevTools is compiled code and therefore differs. - + ## Internals - AST spec ([babylon/ast/spec.md](https://github.com/babel/babylon/blob/master/ast/spec.md)) - Versioning ([doc/design/versioning.md](https://github.com/babel/babel/blob/master/doc/design/versioning.md)