diff --git a/README.md b/README.md index cc997205..9885b346 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ If you need more advanced things like animations, lazy loading of images, or par - [Properties of ``](#properties-of-scrollview) - [Dependencies](#dependencies) - [Development](#development) +- [Automated tests](#automated-tests) - [Special thanks](#special-thanks) - [License](#license) @@ -226,6 +227,8 @@ First make sure that you have [Node.js](https://nodejs.org/), [Yarn](https://yar If you choose to install emulators or simulators, you can use [the example app](/examples) to test your changes in a React Native app. +#### Automated tests + When making changes to the code, please add a unit test or a functional test to verify that the code is working. The test runner that the project uses is [Jest](https://jestjs.io/), [Enzyme](https://airbnb.io/enzyme/) is used to test React Components, and [Detox](https://github.com/wix/Detox) is used to run functional tests against the project's example app. The command to run unit tests is `yarn test` and the command to run functional tests is `yarn functional`. Before you submit the code for a Pull Request, make sure that you run `yarn test`, `yarn tsc`, and `yarn lint` to verify that unit tests pass and both the Typescript type checking and ESLint linting are not printing any errors.