Marmelator/pdf.js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Instructions for automatic linting for Vim users

mduan 2013-01-14 17:32:28 -08:00
parent ce8ade1973
commit 9928133381
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Contributing.md

@ -56,6 +56,15 @@ Make sure your code follows our style guides, run from the pdf.js folder:
```
node make lint
```
***Protip***: If you are a Vim user, then install [syntastic](http://www.vim.org/scripts/script.php?script_id=2736) and add the following line to your `.vimrc`:
```
let g:syntastic_javascript_checker = "gjslint"
```
Now you have automatic linting of your changes to javascript files whenever you save.
**Run Testing**
To ensure your changes didn't introduce any regressions you'll need to run the testing framework. There are four basic types of tests:
@ -113,4 +122,4 @@ If all goes well a collaborator will merge all your changes into the main repo.
## Useful artifacts
* File split (issues #700 and #646)
* API (issue #1100 and [api.js](https://github.com/mozilla/pdf.js/blob/master/src/api.js))
* API (issue #1100 and [api.js](https://github.com/mozilla/pdf.js/blob/master/src/api.js))