diff --git a/README.md b/README.md index 21bd51a..d4fa99e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # Chat Comments — Agent Zero plugin + + +[![plugin-e2e](https://github.com/agent-zero-plugins/agent-zero-plugin-chat-comments/actions/workflows/plugin-e2e.yml/badge.svg?branch=main)](https://github.com/agent-zero-plugins/agent-zero-plugin-chat-comments/actions/workflows/plugin-e2e.yml) [![BDD scenarios](https://img.shields.io/badge/tests-BDD%20e2e-brightgreen)](https://github.com/agent-zero-plugins/agent-zero-plugin-chat-comments/tree/main/tests/e2e/features) [![Release](https://img.shields.io/github/v/tag/agent-zero-plugins/agent-zero-plugin-chat-comments?label=release&sort=semver)](https://github.com/agent-zero-plugins/agent-zero-plugin-chat-comments/tags) [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/agent-zero-plugins/agent-zero-plugin-chat-comments/blob/main/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/agent-zero-plugins/agent-zero-plugin-chat-comments/blob/main/CONTRIBUTING.md) + + + > Select text in any chat message and attach a **Google-Docs-style comment** to it. > Comments are highlighted inline, listed in a manager modal, **persisted per chat**, > and can be sent to the prompt box as a single review request for the agent to address. @@ -157,4 +163,4 @@ telemetry. See [SECURITY.md](SECURITY.md). ## License -[Apache-2.0](LICENSE). +[Apache-2.0](LICENSE). \ No newline at end of file diff --git a/docs/BEHAVIOUR.md b/docs/BEHAVIOUR.md new file mode 100644 index 0000000..0b915e6 --- /dev/null +++ b/docs/BEHAVIOUR.md @@ -0,0 +1,71 @@ +# Chat Comments — behaviour + + + +Each section is one scenario from `tests/e2e/features/`, with the screenshot the +test captured at its final assertion. 11 of 12 scenarios have one. + +## Commenting on a chat + +### The comments control is present +BEH-1, UI-1 + +![The comments control is present](screenshots/the-comments-control-is-present.png) + +### A comment added to a chat is remembered +BEH-2, BEH-11, BEH-12 + +![A comment added to a chat is remembered](screenshots/a-comment-added-to-a-chat-is-remembered.png) + +### A comment can be attached to selected message text +BEH-5, BEH-7, BEH-8 + +![A comment can be attached to selected message text](screenshots/a-comment-can-be-attached-to-selected-message-text.png) + +### A comment carries its attribution and creation time +BEH-8, BEH-11 + +![A comment carries its attribution and creation time](screenshots/a-comment-carries-its-attribution-and-creation-time.png) + +### A comment can be edited +BEH-10 + +![A comment can be edited](screenshots/a-comment-can-be-edited.png) + +### A comment can be deleted +BEH-10 + +![A comment can be deleted](screenshots/a-comment-can-be-deleted.png) + +### Comments stay with their chat when I switch away and back +BEH-3 + +![Comments stay with their chat when I switch away and back](screenshots/comments-stay-with-their-chat-when-i-switch-away-and-back.png) + +### One message can carry several comments +BEH-8, BEH-9 + +![One message can carry several comments](screenshots/one-message-can-carry-several-comments.png) + +### Both my messages and agent replies can be commented +BEH-5, BEH-8 + +![Both my messages and agent replies can be commented](screenshots/both-my-messages-and-agent-replies-can-be-commented.png) + +### An empty comment is not accepted +BEH-8, BEH-12, EC-6 + +![An empty comment is not accepted](screenshots/an-empty-comment-is-not-accepted.png) + +### The comments service rejects malformed requests +BEH-11, EC-4 + +![The comments service rejects malformed requests](screenshots/the-comments-service-rejects-malformed-requests.png) + +### Comments can be sent to the prompt box +BEH-13, BEH-14 + +_No screenshot captured for this scenario in the last run._ diff --git a/docs/screenshots/a-comment-added-to-a-chat-is-remembered.png b/docs/screenshots/a-comment-added-to-a-chat-is-remembered.png new file mode 100644 index 0000000..736f945 Binary files /dev/null and b/docs/screenshots/a-comment-added-to-a-chat-is-remembered.png differ diff --git a/docs/screenshots/a-comment-can-be-attached-to-selected-message-text.png b/docs/screenshots/a-comment-can-be-attached-to-selected-message-text.png new file mode 100644 index 0000000..47de8e9 Binary files /dev/null and b/docs/screenshots/a-comment-can-be-attached-to-selected-message-text.png differ diff --git a/docs/screenshots/a-comment-can-be-deleted.png b/docs/screenshots/a-comment-can-be-deleted.png new file mode 100644 index 0000000..eb54e86 Binary files /dev/null and b/docs/screenshots/a-comment-can-be-deleted.png differ diff --git a/docs/screenshots/a-comment-can-be-edited.png b/docs/screenshots/a-comment-can-be-edited.png new file mode 100644 index 0000000..4174a0e Binary files /dev/null and b/docs/screenshots/a-comment-can-be-edited.png differ diff --git a/docs/screenshots/a-comment-carries-its-attribution-and-creation-time.png b/docs/screenshots/a-comment-carries-its-attribution-and-creation-time.png new file mode 100644 index 0000000..4272f5a Binary files /dev/null and b/docs/screenshots/a-comment-carries-its-attribution-and-creation-time.png differ diff --git a/docs/screenshots/an-empty-comment-is-not-accepted.png b/docs/screenshots/an-empty-comment-is-not-accepted.png new file mode 100644 index 0000000..5d08f19 Binary files /dev/null and b/docs/screenshots/an-empty-comment-is-not-accepted.png differ diff --git a/docs/screenshots/both-my-messages-and-agent-replies-can-be-commented.png b/docs/screenshots/both-my-messages-and-agent-replies-can-be-commented.png new file mode 100644 index 0000000..cea642a Binary files /dev/null and b/docs/screenshots/both-my-messages-and-agent-replies-can-be-commented.png differ diff --git a/docs/screenshots/comments-stay-with-their-chat-when-i-switch-away-and-back.png b/docs/screenshots/comments-stay-with-their-chat-when-i-switch-away-and-back.png new file mode 100644 index 0000000..9ab5880 Binary files /dev/null and b/docs/screenshots/comments-stay-with-their-chat-when-i-switch-away-and-back.png differ diff --git a/docs/screenshots/one-message-can-carry-several-comments.png b/docs/screenshots/one-message-can-carry-several-comments.png new file mode 100644 index 0000000..404c285 Binary files /dev/null and b/docs/screenshots/one-message-can-carry-several-comments.png differ diff --git a/docs/screenshots/the-comments-control-is-present.png b/docs/screenshots/the-comments-control-is-present.png new file mode 100644 index 0000000..977f312 Binary files /dev/null and b/docs/screenshots/the-comments-control-is-present.png differ diff --git a/docs/screenshots/the-comments-service-rejects-malformed-requests.png b/docs/screenshots/the-comments-service-rejects-malformed-requests.png new file mode 100644 index 0000000..417bc43 Binary files /dev/null and b/docs/screenshots/the-comments-service-rejects-malformed-requests.png differ