From 32cb6c763582d65eee74870613eb3e538573507d Mon Sep 17 00:00:00 2001 From: Leynos Date: Tue, 29 Jul 2025 18:26:57 +0100 Subject: [PATCH 1/2] Add build instructions and project overview --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fb1b19e..75d7d13 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ # Comenq -This is a generated project using [Copier](https://copier.readthedocs.io/). +Comenq is a fault-tolerant service that queues GitHub Pull Request comments. It +follows a daemon\-client model: the `comenqd` daemon enforces a 16\-minute +cooling\-off period for posting, while the `comenq` CLI simply enqueues +requests. The architecture and crate choices are described in +[docs/comenq-design.md](docs/comenq-design.md). Further guides in the +[`docs/`](docs/) directory detail testing approaches and library rationale. + +## Building and testing + +Use the provided `make` targets to manage the project: + +- `make build` – compile debug binaries in `target/debug/` +- `make release` – produce optimised release binaries +- `make test` – execute the full test suite +- `make lint` – run Clippy with warnings denied +- `make fmt` – format Rust and Markdown files + +## Running the binaries + +After building, launch the daemon and queue comments with the client: + +```bash +make build +./target/debug/comenqd & +./target/debug/comenq owner/repo 123 "Comment body" +``` + +Queued requests persist on disk and are posted sequentially by the daemon. From 7b6373a3dc225a2111caff6e1f28406f8cd9b134 Mon Sep 17 00:00:00 2001 From: Leynos Date: Wed, 30 Jul 2025 01:54:39 +0100 Subject: [PATCH 2/2] =?UTF-8?q?Use=20Oxford=20=E2=80=9C-ize=E2=80=9D=20spe?= =?UTF-8?q?lling?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 75d7d13..84b400a 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ requests. The architecture and crate choices are described in Use the provided `make` targets to manage the project: - `make build` – compile debug binaries in `target/debug/` -- `make release` – produce optimised release binaries +- `make release` – produce optimized release binaries - `make test` – execute the full test suite - `make lint` – run Clippy with warnings denied - `make fmt` – format Rust and Markdown files