Add Makefile and reference it in guidelines

[leynos]

Summary

• add Makefile with lint, fmt and test helpers
• update AGENTS to use make commands for checks
• fix clippy lint in teardown test

Testing

• make lint
• make test
• make fmt
• mdformat-all
• markdownlint AGENTS.md docs/*.md README.md

---

https://chatgpt.com/codex/tasks/task_e_6853028266308322ba89ae9763829177

Summary by Sourcery

Add a Makefile with lint, test, and fmt targets, update contribution guidelines to reference these make commands, and fix a Clippy lint in the teardown test.

Bug Fixes:

• Fix Clippy lint in teardown test by correcting closure signature

Build:

• Add Makefile with lint, test, and fmt targets wrapping cargo commands

Documentation:

• Update AGENTS.md to reference make fmt, lint, and test targets instead of direct cargo commands

Summary by CodeRabbit

• Chores

  • Updated contributor instructions to use Makefile targets for formatting, linting, and testing instead of direct Cargo commands.
  • Introduced a Makefile with convenient commands for formatting, linting, and testing the Rust project.

• Tests

  • Adjusted a test callback signature to improve consistency with teardown expectations.

[sourcery-ai]

Reviewer's Guide

This PR centralizes project task execution by introducing a Makefile with lint, test, and format targets, updates contribution guidelines in AGENTS.md to reference these commands, and addresses a Clippy lint in the teardown test.

Class diagram for new Makefile targets

classDiagram
    class Makefile {
        +lint()
        +test()
        +fmt()
    }
    Makefile : lint() runs `cargo clippy --all-targets --all-features -- -D warnings`
    Makefile : test() runs `RUSTFLAGS="-D warnings" cargo test --quiet`
    Makefile : fmt() runs `cargo fmt --all`

Loading

File-Level Changes

Change	Details	Files
Add Makefile with lint, test, and fmt targets	Declare PHONY targets for lint, test, and fmt Define lint target wrapping cargo clippy with -D warnings Define test target using RUSTFLAGS to deny warnings and run cargo test quietly Define fmt target to run cargo fmt across the workspace	Makefile
Update contribution guidelines to use Makefile targets	Replace direct cargo fmt, clippy, and test instructions with make fmt, make lint, and make test Explain that make targets wrap the original cargo commands with proper flags	AGENTS.md
Fix Clippy lint in teardown test callback	Change on_connection_teardown closure argument from	_

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Walkthrough

This update introduces a Makefile with fmt, lint, and test targets that wrap standard Rust commands. Contributor instructions in AGENTS.md are updated to reference these Makefile targets instead of direct Cargo commands. Additionally, a test closure in lifecycle.rs is modified to accept an empty tuple for improved signature alignment.

Changes

File(s)	Change Summary
AGENTS.md	Updated contributor instructions to use make fmt, make lint, and make test targets.
Makefile	Added new Makefile with fmt, lint, and test targets wrapping standard Cargo commands.
tests/lifecycle.rs	Changed closure in test to accept empty tuple `

Possibly related PRs

• Add phony targets mxd#115: Both PRs add or modify Makefile phony targets, though this PR introduces more comprehensive Rust-specific targets.
• Update Makefile tests mxd#161: Both PRs update the Makefile's test targets and documentation, but this PR establishes the basic targets while the other splits tests by feature.

Poem

A Makefile hops in, so tidy and neat,
With lint, test, and fmt—a developer treat!
Docs now say "make", not "cargo" direct,
And closure signatures are now correct.
🐇✨
Rusty chores made easy,
CodeRabbit’s work is never cheesy!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3f43136 and 8ab6bdb.

📒 Files selected for processing (3)

• AGENTS.md (1 hunks)
• Makefile (1 hunks)
• tests/lifecycle.rs (1 hunks)

🧰 Additional context used

🪛 checkmake (0.2.2)

Makefile

[warning] 1-1: Missing required phony target "all"

(minphony)

---

[warning] 1-1: Missing required phony target "clean"

(minphony)

🔇 Additional comments (3)

tests/lifecycle.rs (1)

70-70: LGTM! Improved type safety for teardown callback.

The change from |_| to |()| correctly aligns the closure signature with the expected teardown callback when no setup state is provided, which is appropriate for this test scenario.

Makefile (1)

1-17: LGTM! Well-structured Makefile for development workflow.

The Makefile effectively centralises common development tasks with appropriate flags:

• lint properly enforces clippy warnings as errors
• test correctly treats warnings as errors and uses quiet output
• fmt formats the entire workspace
• All targets are properly declared as phony

The static analysis hints about missing "all" and "clean" targets are not critical for this development-focused Makefile.

AGENTS.md (1)

97-99: LGTM! Documentation correctly references new Makefile targets.

The update properly replaces direct cargo commands with the new Makefile targets whilst maintaining clarity about the underlying functionality. This provides a consistent developer experience and aligns with the introduced Makefile.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch codex/add-makefile-with-lint,-test,-and-fmt-targets

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sourcery-ai]

Hey @leynos - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}