Skip to content

Update README with build instructions #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leynos merged 2 commits into from
Jul 30, 2025
Merged

Update README with build instructions #18

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32cb6c7
Add build instructions and project overview
leynos Jul 29, 2025
7b6373a
Use Oxford “-ize” spelling
leynos Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Comment on lines +4 to +5
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jul 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick (assertive)

Remove unnecessary back-slash escapes around hyphens

The back-slashes before the hyphens are not required outside code blocks and
reduce readability. Drop them to keep the prose clean.

- follows a daemon\-client model: the `comenqd` daemon enforces a 16\-minute
- cooling\-off period for posting, while the `comenq` CLI simply enqueues
+ follows a daemon-client model: the `comenqd` daemon enforces a 16-minute
+ cooling-off period for posting, while the `comenq` CLI simply enqueues
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
follows a daemon\-client model: the `comenqd` daemon enforces a 16\-minute
cooling\-off period for posting, while the `comenq` CLI simply enqueues
follows a daemon-client model: the `comenqd` daemon enforces a 16-minute
cooling-off period for posting, while the `comenq` CLI simply enqueues
🤖 Prompt for AI Agents 
In README.md around lines 4 to 5, remove the unnecessary backslash escapes
before the hyphens in the text outside of code blocks. Simply delete the
backslashes preceding the hyphens to improve readability and keep the prose
clean.

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.

Comment thread
leynos marked this conversation as resolved.
## Building and testing

Use the provided `make` targets to manage the project:

- `make build` – compile debug binaries in `target/debug/`
- `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

## 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.