Skip to content

Commit 0b5ca86

Browse files
authored
feat: update dev guide with test doc best practices (#309)
1 parent 88d338b commit 0b5ca86

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/DEVELOPER_GUIDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ secret = Secret(name=request.param["name"], model_dir=request.param["model-dir"]
141141
Check [pytest.ini](../pytest.ini) for available markers; additional markers can always be added when needed.
142142
- Classes are good to group related tests together, for example when they share a fixture.
143143
You should NOT group unrelated tests in one class (because it is misleading the reader).
144+
- All the tests should be properly documented. Every test (or test class), should have a docstring explaning what the test does so that anyone (engineers from other components, managers, PMs, or non-technical users) can have a basic understanding of what the code is trying to test without having to dive into the technical details of related functions or fixtures.
144145

145146

146147
## Check the code

0 commit comments

Comments
 (0)