ale/PULL_REQUEST_TEMPLATE.md

813 B

When creating new pull requests, please consider the following.

  • Read the Contributing guide linked above first.
  • If you are adding a new linter, remember to update the README.md file and doc/ale.txt first.
  • If you add or modify a function for converting error lines into loclist items that ALE can work with, please add Vader tests for them. Look at existing tests in the test/handler directory, etc.
  • If you add or modify a function for computing a command line string for running a command, please add Vader tests for that.
  • Generally try and cover anything with Vader tests, although some things just can't be tested with Vader, or at least they can be hard to test. Consider breaking up your code so that some parts can be tested, and generally open up a discussion about it.
  • Have fun!