diff mbox series

[blktests,4/4] README: clarify motivations to add new test cases

Message ID 20230728110720.1280124-5-shinichiro.kawasaki@wdc.com (mailing list archive)
State New, archived
Headers show
Series clarify confusions in blktests contributions | expand

Commit Message

Shinichiro Kawasaki July 28, 2023, 11:07 a.m. UTC 
It is often questioned when new test cases should be added to blktests.
Clarify it in "Adding Tests" section.

Signed-off-by: Shin'ichiro Kawasaki <shinichiro.kawasaki@wdc.com>
---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)
diff mbox series

Patch

diff --git a/README.md b/README.md
index 201d11c..6610078 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,14 @@  configuration and running tests.
 
 ## Adding Tests
 
+New test cases are welcomed when,
+
+- a bug in block layer or storage stack is found and the new test case confirms
+  fix of the bug,
+- a new feature is introduced in block layer or storage stack, and the new test
+  cases confirm that the feature is working well, or,
+- the new test cases extend coverage of block layer and storage stack code.
+
 The `./new` script creates a new test from a template. The generated template
 contains more detailed documentation. [The ./new script itself](new) can be
 referred as a document. It describes variables and functions that test cases