diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fc5760ff8..7721a3434 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,6 +45,11 @@ Here's what you can do to help: - Be sure to run `npm run test`. It is going to run all tests for all snippets. - Make a new pull request **only if all the tests are passing**. +#### Browser specific tests +- If your snippet belongs to `browser` category then you will need to modify the tests to make them work. +- By default, `NodeJS` isn't browser environment. That said we have to use external package to help us simulate the browser for our tests. +- We use [jsdom](https://www.npmjs.com/package/jsdom) for our browser specific tests. You can find their [documentation](https://github.com/jsdom/jsdom) on GitHub as well. + ### Additional guidelines and conventions regarding snippets