Proofreader

Each pull request (PR) is being validated by Travis CI using Proofreader. Proofreader is a tool that combines spellchecker and hemingwayapp-like suggestions.

Validation results should be available under a minute after PR was created, but the exact time depends on PR size. Only files that were modified are being processed (instead of the whole repository). Failed validation triggers github to show a message similar to the one below:

'Details' link points to the full report of all issues found by Proofreader.

False positives

Spellchecker may complain about words and names that are correct but are missing from the dictionary. These words should be added to devtools-docs.dic (note that number at the top of the file should be manually increased with each word).

Write-good (responsible for non-spelling suggestions) can be configured. Currently it does perform all checks listed here.

Configuration files

• .travis.yml - Travis CI configuration file
• devtools-docs.dic - dictionary of DevTools specific words (far from complete)
• package.json - tells Travis CI how to run tests and what's required to run them (proofreader)
• proofreader-settings.json - proofreader settings (which tags should be validated, what dictionaries should be used)