2017-04-23 17:17:13 +00:00
|
|
|
<!--
|
2017-07-22 18:31:48 +00:00
|
|
|
READ THIS: Before creating a pull request, please consider the following first.
|
2017-04-08 20:53:39 +00:00
|
|
|
|
2017-07-22 18:31:48 +00:00
|
|
|
* The most important thing you can do is write tests. Code without tests
|
2017-08-19 12:14:53 +00:00
|
|
|
probably doesn't work, and will almost certainly stop working later on. Pull
|
|
|
|
requests without tests probably won't be accepted, although there are some
|
|
|
|
exceptions.
|
2017-04-08 20:53:39 +00:00
|
|
|
* 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
|
2018-05-15 12:14:20 +00:00
|
|
|
running a command, please add Vader tests for that. Look at existing
|
|
|
|
tests in the test/command_callback directory, etc.
|
2017-04-08 20:53:39 +00:00
|
|
|
* 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!
|
2017-04-23 17:17:13 +00:00
|
|
|
-->
|