diff options
author | w0rp <devw0rp@gmail.com> | 2017-04-08 21:53:39 +0100 |
---|---|---|
committer | w0rp <devw0rp@gmail.com> | 2017-04-08 21:53:39 +0100 |
commit | b9bb4adacda521ac98b3ed656cd328ae36835e40 (patch) | |
tree | 03f8b79d8a18c5aca94819609a63481834e7f551 /PULL_REQUEST_TEMPLATE.md | |
parent | 94d5fcb15aae637522732354936b4618645b79b4 (diff) | |
download | ale-b9bb4adacda521ac98b3ed656cd328ae36835e40.zip |
Add a pull request template which asks for some common requests by yours truly
Diffstat (limited to 'PULL_REQUEST_TEMPLATE.md')
-rw-r--r-- | PULL_REQUEST_TEMPLATE.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..89ff87a2 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +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! |