From 0fa310bdb50670f526c06d18d1b91b8f568b1c1e Mon Sep 17 00:00:00 2001 From: Robrecht Cannoodt Date: Wed, 14 Feb 2024 10:52:38 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 24bdf769..896b2e46 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -230,7 +230,7 @@ Finally, add all other arguments to the config file. There are a few exceptions: Note: -* If the documentation mentions a default value for some of the arguments, please don't add them as default values in the Viash config, but instead as an example. This is because the documentation of the tool might be incorrect or outdated, and by adding a default value to the Viash config we might be changing the default behaviour of the tool. For example, do not write `name: --my_arg, description: My arg, default: 10`, but instead `name: --my_arg, description: "My arg. Default: 10.", example: 10`. +* If the documentation mentions a default value for some of the arguments, please don't add them as default values in the Viash config, but instead as an example. This is because the documentation of the tool might be incorrect or outdated, and by adding a default value to the Viash config we might be changing the default behaviour of the tool. For example, do not write `name: --my_arg, description: "", default: 10`, but instead `name: --my_arg, description: ". Default: 10.", example: 10`. ### Step 10: Add a Docker engine