diff --git a/Contributing.md b/Contributing.md index 8c6b303..0ad1c4f 100644 --- a/Contributing.md +++ b/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)) \ No newline at end of file