Document create-project-issue (#18)

Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
katexochen · Apr 11, 2023 · 5c503ac · 5c503ac
1 parent 7428578
commit 5c503ac
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,35 @@
 # ghh - GitHub Helper tool
+
+## `create-project-issue`
+
+Create project issue creates a new draft issue in a GitHub
+project board. Metadata can be added in the form of fields and
+users can be assigned.
+
+The command takes two inputs: a path to an issue body (markdown or plain text)
+and a path to a JSON document of metadata. The metadata file looks like this:
+
+```json
+{
+    "organization": "<your org>",
+    "projectNumber": 42,
+    "issueTitle": "<your issue title>",
+    "assignees": [
+        "<login>"
+    ],
+    "fields": {
+        "Status": "<board column>",
+        "field1": "value1",
+        "field2": "value2"
+    }
+}
+```
+
+The project number is part of the URL of your target project board.
+
+![GitHub project board URL](assets/project-url.png)
+
+For boards with columns, the column is also a field. You can find the
+field name and the possible values in your project settings.
+
+![GitHub project settings](assets/project-settings.png)
diff --git a/assets/project-settings.png b/assets/project-settings.png
diff --git a/assets/project-url.png b/assets/project-url.png