diff options
| -rw-r--r-- | .gitattributes | 1 | ||||
| -rw-r--r-- | PULL_REQUEST_TEMPLATE.md | 15 |
2 files changed, 16 insertions, 0 deletions
diff --git a/.gitattributes b/.gitattributes index 060e8ad2..799cd671 100644 --- a/.gitattributes +++ b/.gitattributes @@ -3,6 +3,7 @@ /Dockerfile export-ignore /ISSUE_TEMPLATE.md export-ignore /Makefile export-ignore +/PULL_REQUEST_TEMPLATE.md export-ignore /README.md export-ignore /custom-checks export-ignore /img export-ignore 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! |