@we-scrum/cli 6.9.3 → 6.9.5

package/README.md

@@ -56,6 +56,21 @@ we-scrum start-task --identificationNumber <id> --changeId <changeId>      # Mar
 we-scrum complete-task --identificationNumber <id> --changeId <changeId>   # Mark the current in-progress task as done
 ```
 
+### Change threads
+
+Change threads are conversations attached to a change (task) in the we-scrum web app. They are used to request adjustments on a task, and to report deviations from the task description or feedback on the development guidelines.
+
+```bash
+we-scrum get-change-threads --changeId <changeId>                                            # List all threads of a change (any status), with their comments
+we-scrum create-change-thread --changeId <changeId> --comment <comment>                      # Open a new thread with a first comment
+we-scrum add-comment-to-change-thread --changeThreadId <id> --comment <comment>              # Reply to an existing thread
+we-scrum update-change-thread-status --changeThreadId <id> --status <Open|Resolved|Archived> # Change the status of a thread
+```
+
+Comments support markdown. `get-change-threads` returns every thread of the change, whatever its status (`Open`, `Resolved`, `Archived`), ordered by status (`Open` first, then `Resolved`, then `Archived`) and, within a status, by creation date. This gives the complete history and lets you reply to an existing thread instead of creating a duplicate.
+
+The `get-next-task` output tells you when to use these commands: read the threads before implementing, resolve the open ones you addressed, and before completing a task post a thread for any deviation from the task description or for missing development guidelines.
+
 ### Automation breakpoints
 
 A developer can set a breakpoint on a change from the we-scrum web app to pause automated development at that point. When `get-next-task` hits a change with a breakpoint set, it halts and reports the pause instead of proceeding.