on master help sign in
CONTRIBUTING.md: Encourage regression tests (#2089)

* CONTRIBUTING.md: Encourage regression tests * Add colon before listing pros of regression tests Co-authored-by: Keith Hall <keith-hall@users.noreply.github.com>

commit1ee49b4d97cdb22c9303788b78366714c5db346c authorMartin Nordholts <enselic@gmail.com> dateSat 26 Feb 2022, 17:03 (5 years ago) parent14ddda0
1 file changed+22
CONTRIBUTING.md+22
CONTRIBUTING.md+22
@@ -46,3 +46,25 @@ If you really think that a particular syntax or theme should be added for all
4646users, please read the corresponding
4747[documentation](https://github.com/sharkdp/bat/blob/master/doc/assets.md)
4848first.
49+
50+
51+## Regression tests
52+
53+You are strongly encouraged to add regression tests. Regression tests are great,
54+not least because they:
55+
56+* ensure that your contribution will never completely stop working,
57+
58+* makes code review easier, because it becomes very clear what the code is
59+ supposed to do.
60+
61+For functional changes, you most likely want to add a test to
62+[`tests/integration_tests.rs`](https://github.com/sharkdp/bat/blob/master/tests/integration_tests.rs).
63+Look at existing tests to know how to write a new test. In short, you will
64+invoke the `bat` binary with a certain set of arguments, and then assert on
65+stdout/stderr.
66+
67+To learn how to write regression tests for theme and syntax changes, read the
68+[Syntax
69+tests](https://github.com/sharkdp/bat/blob/master/doc/assets.md#syntax-tests)
70+section in `assets.md`.