Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Add testing example and supporting links.

This commit is contained in:
Karl Stolley 2023-05-24 12:26:14 -05:00 committed by Tim Abbott
parent fe1b7a9bb3
commit ee7b6f476d
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/contributing/code-style.md
View File

@ -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