From 7736db5182750aeed2bab123faeb7c176b8a3d65 Mon Sep 17 00:00:00 2001 From: Peeyush Kushwaha Date: Sun, 28 May 2017 21:26:03 +0530 Subject: [PATCH 1/3] Add a section on troubleshooting [skip ci] --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f979d6d797bd..dac5ff2f4081 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -236,6 +236,17 @@ The debugger starts at the first executed line of code, which is Mocha's first l 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. +## Troubleshooting + +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. + ## 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) From 1523123f3f3a43af010daa75c9759ec1b546d967 Mon Sep 17 00:00:00 2001 From: Peeyush Kushwaha Date: Mon, 29 May 2017 18:38:04 +0530 Subject: [PATCH 2/3] Move troubleshooting section to be under the running tests section --- CONTRIBUTING.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dac5ff2f4081..5ad38a05b33a 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,17 +247,6 @@ 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. - -## Troubleshooting - -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. ## Internals - AST spec ([babylon/ast/spec.md](https://github.com/babel/babylon/blob/master/ast/spec.md)) From d6951fc0ba3ea6d7cb95a9919902ca7433bea38e Mon Sep 17 00:00:00 2001 From: Henry Zhu Date: Mon, 29 May 2017 11:19:44 -0400 Subject: [PATCH 3/3] [skip ci] --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5ad38a05b33a..4ea00201696f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -140,7 +140,7 @@ In case you're not able to reproduce an error on CI locally, it may be due to 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. + - Updates in Dependencies: Make sure you run `make bootstrap` before you run `make build` or `make watch` before you run the tests. ### Writing tests