From ee7b6f476dab1c14e53f1f726cc0561f27cd0ed1 Mon Sep 17 00:00:00 2001 From: Karl Stolley Date: Wed, 24 May 2023 12:26:14 -0500 Subject: [PATCH] docs: Add testing example and supporting links. --- docs/contributing/code-style.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/contributing/code-style.md b/docs/contributing/code-style.md index 8d85484d6a..bc87cb08d6 100644 --- a/docs/contributing/code-style.md +++ b/docs/contributing/code-style.md @@ -85,10 +85,21 @@ $ ./tools/setup-git-repo ### Use tests to verify your logic Clear, readable code is important for [tests](../testing/testing.md); -familiarize yourself with our testing frameworks so that you can write +familiarize yourself with our +[testing frameworks](../testing/testing.md#major-test-suites) and +[testing philosophy](../testing/philosophy.md) so that you can write clean, readable tests. In-test comments about anything subtle that is being verified are appreciated. +You can run all of the tests like this: + +``` +$ ./tools/test-all +``` + +But consult [our documentation on running tests](../testing/testing.md#running-tests), +which covers more targeted approaches to commanding the test-runners. + ## Follow Zulip conventions and practices What follows is language-neutral advice that is beyond the bounds of