Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rcannood authored Feb 14, 2024
1 parent d0ac572 commit 0fa310b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: "<description>", default: 10`, but instead `name: --my_arg, description: "<description>. Default: 10.", example: 10`.


### Step 10: Add a Docker engine
Expand Down

0 comments on commit 0fa310b

Please sign in to comment.