You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14-34Lines changed: 14 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,11 +55,9 @@ Granted that you share your thoughts, we might even be able to come up with crea
55
55
56
56
First of all, **sorry about that!** We want you to have a great time with Kibana.
57
57
58
-
Hosting meaningful discussions on GitHub can be challenging. For that reason, we'll sometimes ask that you join us on IRC _([#kibana](https://kiwiirc.com/client/irc.freenode.net/?#kibana) on freenode)_ to chat about your issues. You may also experience **faster response times** when engaging us via IRC.
59
-
60
58
There's hundreds of open issues and prioritizing what to work on is an important aspect of our daily jobs. We prioritize issues according to impact and difficulty, so some issues can be neglected while we work on more pressing issues.
61
59
62
-
Feel free to bump your issues if you think they've been neglected for a prolonged period, or just jump on IRC and let us have it!
60
+
Feel free to bump your issues if you think they've been neglected for a prolonged period.
63
61
64
62
### "I want to help!"
65
63
@@ -471,11 +469,11 @@ The following table outlines possible test file locations and how to invoke them
471
469
472
470
| Test runner | Test location | Runner command (working directory is kibana root) |
yarn test:ftr:runner --config test/api_integration/config.js --grep='should return 404 if id does not match any sample data sets'
499
497
```
500
498
501
499
### Debugging Unit Tests
502
500
503
501
The standard `yarn test` task runs several sub tasks and can take several minutes to complete, making debugging failures pretty painful. In order to ease the pain specialized tasks provide alternate methods for running the tests.
504
502
505
-
To execute both server and browser tests, but skip linting, use `yarn test:quick`.
506
-
507
-
```bash
508
-
yarn test:quick
509
-
```
510
-
511
-
Use `yarn test:mocha` when you want to run the mocha tests.
512
-
513
-
```bash
514
-
yarn test:mocha
515
-
```
516
-
517
-
When you'd like to execute individual server-side test files, you can use the command below. Note that this command takes care of configuring Mocha with Babel compilation for you, and you'll be better off avoiding a globally installed `mocha` package. This command is great for development and for quickly identifying bugs.
518
-
519
-
```bash
520
-
node scripts/mocha <file>
521
-
```
522
-
523
503
You could also add the `--debug` option so that `node` is run using the `--debug-brk` flag. You'll need to connect a remote debugger such as [`node-inspector`](https://github.com/node-inspector/node-inspector) to proceed in this mode.
524
504
525
505
```bash
526
506
node scripts/mocha --debug <file>
527
507
```
528
508
529
-
With `yarn test:browser`, you can run only the browser tests. Coverage reports are available for browser tests by running `yarn test:coverage`. You can find the results under the `coverage/` directory that will be created upon completion.
509
+
With `yarn test:karma`, you can run only the browser tests. Coverage reports are available for browser tests by running `yarn test:coverage`. You can find the results under the `coverage/` directory that will be created upon completion.
530
510
531
511
```bash
532
-
yarn test:browser
512
+
yarn test:karma
533
513
```
534
514
535
-
Using `yarn test:dev` initializes an environment for debugging the browser tests. Includes an dedicated instance of the kibana server for building the test bundle, and a karma server. When running this task the build is optimized for the first time and then a karma-owned instance of the browser is opened. Click the "debug" button to open a new tab that executes the unit tests.
515
+
Using `yarn test:karma:debug` initializes an environment for debugging the browser tests. Includes an dedicated instance of the kibana server for building the test bundle, and a karma server. When running this task the build is optimized for the first time and then a karma-owned instance of the browser is opened. Click the "debug" button to open a new tab that executes the unit tests.
536
516
537
517
```bash
538
-
yarn test:dev
518
+
yarn test:karma:debug
539
519
```
540
520
541
521
In the screenshot below, you'll notice the URL is `localhost:9876/debug.html`. You can append a `grep` query parameter to this URL and set it to a string value which will be used to exclude tests which don't match. For example, if you changed the URL to `localhost:9876/debug.html?query=my test` and then refreshed the browser, you'd only see tests run which contain "my test" in the test description.
@@ -551,7 +531,7 @@ To run the tests for just your particular plugin run the following command from
551
531
552
532
```bash
553
533
yarn test:mocha
554
-
yarn test:browser --dev # remove the --dev flag to run them once and close
534
+
yarn test:karma:debug # remove the debug flag to run them once and close
(Optional, boolean) Overwrite any existing objects on ID conflict.
19
-
19
+
20
20
`exclude`::
21
21
(Optional, array) Saved object types that you want to exclude from the import.
22
22
@@ -28,14 +28,14 @@ Use the complete response body from the <<dashboard-api-export, Export dashboard
28
28
[[dashboard-api-import-response-body]]
29
29
==== Response body
30
30
31
-
`objects`::
32
-
(array) A top level property that includes the saved objects.
31
+
`objects`::
32
+
(array) A top level property that includes the saved objects.
33
33
34
34
[[dashboard-api-import-codes]]
35
35
==== Response code
36
36
37
37
`200`::
38
-
Indicates a successful call, even if there are errors importing individual saved objects. If there ar errors, the error information is returned in the response body on an object-by-object basis.
38
+
Indicates a successful call, even if there are errors importing individual saved objects. If there are errors, the error information is returned in the response body on an object-by-object basis.
0 commit comments