aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorKarl Schultz <karl@lunarg.com>2016-04-28 13:55:42 -0600
committerKarl Schultz <karl@lunarg.com>2016-04-28 13:55:42 -0600
commit73220adce62af521a952460d909cfdca217612fe (patch)
tree5389989b0e0fce2825eeb67d78d0dac7f93a24e2 /CONTRIBUTING.md
parent65b115b1506379f56ae219098ec1301ebdfebfa9 (diff)
downloadvulkan-tools-73220adce62af521a952460d909cfdca217612fe.tar.gz
docs: Add info for layer tests to CONTRIBUTING
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 478e7a0d..f3933ec7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -66,6 +66,17 @@ that might arise with Vulkan-LoaderAndValidationLayers components if they were o
* Run tests that explicitly exercise your changes.
* Feel free to subject your code changes to other tests as well!
+#### **Special Considerations for Validation Layers**
+If you are submitting a change that adds a new validation check, you should also construct a "negative" test function.
+The negative test function purposely violates the validation rule that the new validation check is looking for.
+The test should cause your new validation check to identify the violation and issue a validation error report.
+And finally, the test should check that the validation error report is generated and consider the test as "passing"
+if the report is received. Otherwise, the test should indicate "failure".
+This new test should be added to the validation layer test program in the `tests` directory and contributed
+at the same time as the new validation check itself.
+There are many existing validation tests in this directory that can be used as a starting point.
+
+
### **Contributor License Agreement (CLA)**
#### **Khronos Repository (Vulkan-LoaderAndValidationLayers)**