From 0bb3acef876b905da46f4ca5bf6d3784388abdf6 Mon Sep 17 00:00:00 2001 From: Alexander Medvednikov Date: Sat, 29 Jun 2019 16:50:13 +0200 Subject: [PATCH] PR template: ask for fn docs and tests --- .github/PULL_REQUEST_TEMPLATE | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 87ad6a72ac..e9f2c0cfae 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -3,6 +3,19 @@ Don't use past tense (e.g. "fixed foo bar"). Explain what your PR does and why. +If you are adding a new function, please document it and add tests: + +``` +// foo does foo and bar +fn foo() { + +// file_test.v +fn test_foo() { + assert foo() == ... + ... +} +``` + Before submitting a PR, please run the tests with `make test`, and make sure V can still compile itself. Run this twice: ./v -o v