From eaf30e8932b005a1f3df06b6d42a64af06a1a5c7 Mon Sep 17 00:00:00 2001 From: Jeremy Kniager Date: Thu, 14 Mar 2019 09:24:05 -0600 Subject: [PATCH] docs: Update CONTRIBUTING.md Updated CONTRIBUTING.md to link to instructions about validating vulkaninfo JSON output. --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fab01a8..6723c37 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,7 +72,9 @@ that to be accepted into the repository, the pull request must [pass all tests]( > vkcube --validate * In the `vulkaninfo` directory, run: > vulkaninfo - +* If you are adding or changing JSON output, please read + [Validating vulkaninfo JSON output](https://github.com/KhronosGroup/Vulkan-Tools/blob/master/vulkaninfo/json_validation_process.md). + **Note:** When adding new output to vulkaninfo, do NOT add JSON output unless the formmatting is defined by a schema. * Run tests that explicitly exercise your changes. * Feel free to subject your code changes to other tests as well! -- 2.7.4