andre/30-seconds-of-code
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #574 from Chalarangelo/documentation

Browse Source 
[FIX] Documentation
This commit is contained in:
Angelos Chalaris
2018-01-27 17:01:41 +02:00
committed by GitHub
parent 106b2c92b6 7f885abed6
commit 88f0dd34da
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -45,7 +45,10 @@ 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, `Node.js` isn't browser environment. That said we have to use an 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