This tool helps you make sure your LaTeX document compiles without issues.

First, you install it:

$ gem install texqc

Then, you just run it after the LaTeX document is compiled:

$ latexmk -pdf article
$ texqc article

If any warnings were reported by LaTeX, you will get a short list of them and the exit code will be non-zero (very convenient for your CI/CD scripts).

To make configuration easier, you can create .texqc file next to your .tex file and place all your command line configuration options over there, each one on its own line. You can also have a global configuration file at ~/.texqc, which will be read first.

Read these guidelines. Make sure your build is green before you contribute your pull request. You will need to have Ruby 2.3+ and Bundler installed. Then:

$ bundle update
$ bundle exec rake

If it's clean and you don't see any error messages, submit your pull request.