From 98c8c1ab3c85de71f391bc49194b96dd4127265a Mon Sep 17 00:00:00 2001
From: Sam Likins <sam.likins@wsi-services.com>
Date: Sat, 15 Apr 2023 09:34:19 -0700
Subject: [PATCH] Added commands-description section to guideline.

---
 guidelines/index.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/guidelines/index.md b/guidelines/index.md
index c7c49a5..c7f55b5 100644
--- a/guidelines/index.md
+++ b/guidelines/index.md
@@ -122,6 +122,16 @@ $ bpkg run say-hello "Bash Package Manager"
 Hello Bash Package Manager
 ```
 
+### commands-description (optional)
+
+This is a hash of descriptions for configured commands.  The keys are the names of the commands and the values are the descriptions for the specified commands.  The command descriptions can be listed on the command line by providing the `-l` or `--list` flags after the `bpkg run` command.
+
+```json
+  "commands-description": {
+    "say-hello": "Output hello to provided name (ex: bpkg run say-hello John)"
+  }
+```
+
 ## Packaging best practices
 
 These are guidelines that we strongly encourage developers to follow.