From 61fdcbf5cf1a22fa074c7e7f38536b33782f5572 Mon Sep 17 00:00:00 2001 From: Scott Chamberlain Date: Wed, 15 Jan 2025 09:54:47 -0800 Subject: [PATCH] #59 add instructions in contributing.md doc for prefixes for bad files --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2f12f29..16766d5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -18,7 +18,7 @@ New unit test suggestions are tracked as GitHub issues. When creating a unit tes 1. Clone the repo locally and create your branch from `main` 2. Ensure your proposed WDL runs locally via `miniwdl run` or `cromwell run` -3. Add the WDL to a subdirectory by the same name, i.e. `coolUnitTest/coolUnitTest.wdl` +3. Add the WDL to a subdirectory by the same name, i.e. `coolUnitTest/coolUnitTest.wdl`. If the WDL is expected to fail WOMtool the subdirectory AND the WDL file name must start with `badVal`. If the WDL is expected to fail both WOMtool and a Cromwell run, then the subdirectory AND the WDL file name must start with `badRun`. 4. Make sure to include an `inputs.json` and `options.json` if required and that any other input files referenced in `inputs.json` are provided in the same directory 5. Add a README to the WDL's subdirectory describing the unit test's functionality and purpose 6. Update the overarching repo's README as well