Update CONTRIBUTING.md for use case on template usage
Change-Id: Iedabcb8c7cf8e6809a5b341ea19dcdb6386106ce
Signed-off-by: George Keishing <gkeishin@in.ibm.com>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index bc03333..fc02e85 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -359,6 +359,16 @@
${HTTP_NOT_FOUND} /xyz/i/dont/exist/
```
+ Note: Normally, a template test case would have many rows of data arguments as in the example above.
+ However, contributors frequently define multiple template test cases that each have only
+ one row of data which may seem to defeat the value of using templates in the first place. However,
+ it is done for these reasons:
+ 1) Template tests are counted as a single test. The user may wish to have separate results for
+ each call to the template function.
+ 2) If any call to the template function fails, one would like FFDC data collected immediately
+ and would like one set of FFDC data for EACH such failure.
+
+
Python Coding Guidelines
-----------------------
- The minimum required Python version is 2.7.x.