diff --git a/Contributing.md b/Contributing.md index 6658d66..bcf892a 100644 --- a/Contributing.md +++ b/Contributing.md @@ -19,6 +19,8 @@ An overview how to contribute code to the pdf.js project. The basic workflow: * make * jslint +Before you make any changes to the code you'll probably want jump down to the section on "Generating Reference Images" to create the reference snapshot images so you can run the test framework and check for regressions. + If you're familiar with github and doing feature branches you can skip down to "4) Run Lint and Testing"... ### 1) Fork @@ -48,8 +50,8 @@ To ensure your changes didn't introduce any regressions you'll need to run the t * load - just checks if the pdf file can be loaded without crashing * eq - a reference test which takes correctly rendered snapshots and compares them to the snapshots created by the current code * fbf - a forward back forward test - -The reference tests require you to generate the original snapshots for comparison. The snapshots should be generated before you make any changes to the code. To generate these snapshots: +**Generating Reference Images** +The reference tests require you to generate the original snapshots for comparison. The snapshots should be generated before you make any changes to the code. For my development I have two pdf.js folders one that is checkout from the mozilla master and one from my own fork. I never modify the mozilla master folder except for updating and use it to generate snapshots and then move them over to my forked pdf.js folder. If you are diligent you can just use one folder and always update the snapshots before you make code changes. To generate these snapshots: ``` cd pdf.js/test/