1 | # Good Eggs Test Helpers
|
2 |
|
3 | [![Build Status](https://travis-ci.org/goodeggs/goodeggs-test-helpers.svg?branch=master)](https://travis-ci.org/goodeggs/goodeggs-test-helpers)
|
4 |
|
5 | Basic setup used for all Good Eggs tests.
|
6 |
|
7 | ## Test structure
|
8 |
|
9 | Good Eggs tests use the BDD testing DSL from [mocha](https://mochajs.org/), with a few extras.
|
10 |
|
11 | ## Assertions
|
12 |
|
13 | Good Eggs tests use [chai](http://chaijs.com/), with a bunch of plugins ready for you.
|
14 |
|
15 | ## Contributing
|
16 |
|
17 | Please follow our [Code of Conduct](CODE_OF_CONDUCT.md) when contributing to this project.
|
18 |
|
19 | ```
|
20 | yarn install
|
21 | yarn test
|
22 | ```
|
23 |
|
24 | ## Releasing
|
25 |
|
26 | To release a new version of this module, use yarn to bump the version
|
27 | in `package.json` and create a git tag, then push. This will automatically
|
28 | get published to the NPM registry via CI.
|
29 |
|
30 | ```sh
|
31 | yarn version --new-version=<major|minor|patch|premajor|preminor|prepatch>
|
32 | git push --follow-tags
|
33 | ```
|
34 |
|
35 | ## License
|
36 |
|
37 | [MIT](License.md)
|