Skip to content

Commit a969815

Browse files
committed
code review
1 parent 68562da commit a969815

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Workflows
22

3-
The repo for all _global_ Workflows that appear within Warp and within [commands.dev](https://www.commands.dev/).
3+
The repo for all _public_ Workflows that appear within Warp and within [commands.dev](https://www.commands.dev/).
44

55
**To learn how to create local or repository workflows, see [our docs](https://github.com/warpdotdev/warp-internal/pull/2205).**
66

@@ -31,8 +31,10 @@ Additionally, see the workflow below as an example to quickly get started:
3131
# The name of the workflow.
3232
name: Uninstall a Homebrew package and all of its dependencies
3333
# The corresponding command for the workflow. Any arguments should be surrounded with two curly braces. E.g `command {{arg}}`.
34-
command: "brew tap beeftornado/rmtree\nbrew rmtree {{package_name}}"
35-
# Any tags that workflow should be categorized with.
34+
command: |-
35+
brew tap beeftornado/rmtree
36+
brew rmtree {{package_name}}
37+
# Any tags that the workflow should be categorized with.
3638
tags:
3739
- homebrew
3840
# A description the workflow.
@@ -83,8 +85,9 @@ cargo build
8385
### What Makes a Useful Workflow?
8486
A good workflow is one that includes a command with many flags or arguments or one that is hard to remember.
8587

86-
Additionally, a workflow should include:
88+
Additionally, a workflow _must_ include:
8789

88-
* A descriptive title that includes the name of the command.
89-
* A description for the workflow and each of its argument, if applicable.
90+
* A descriptive title that includes the name of the command--this is useful for improving the experience of searching for workflows in Warp or [commands.dev](https://www.commands.dev/).
91+
* A tag that accurately categorizes the workflows. We ask that you avoid many repetitive tags to improve searchability of workflows within Warp.
92+
* A description for the workflow and each of its arguments, if applicable.
9093
* A default value for each argument, if applicable.

0 commit comments

Comments
 (0)