Dev

[ypriverol]

No description provided.

[qodo-code-review]

ⓘ You are approaching your monthly quota for Qodo. Upgrade your plan

Review Summary by Qodo

Remove Package Structure and Development sections from README

📝 Documentation

Walkthroughs

Description

• Removed Package Structure section from README
• Removed Development section with testing and linting instructions

Diagram

flowchart LR
  README["README.md"]
  README -- "removed sections" --> Removed["Package Structure<br/>Development"]

Loading

File Changes

1. README.md 📝 Documentation +0/-40

Remove Package Structure and Development documentation

• Deleted Package Structure section documenting directory layout and module organization
• Deleted Development section with pytest, ruff, and mypy commands
• Removed 40 lines of documentation content

README.md

---

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 📎 Requirement gaps (0)

1. Missing dev workflow docs 🐞 Bug ⛯ Reliability

Description

The README no longer documents how to run the project’s standard local quality gates (ruff, pytest,
mypy), even though CI still enforces them. This increases friction for contributors trying to
reproduce CI failures locally.

Code

README.md[L318-329]

-## Development
-
-```bash
-# Run tests
-pytest tests/ -v
-
-# Lint
-ruff check src/ tests/
-
-# Type check
-mypy src/pyprideap/
-```

Evidence

After this change, README goes directly from usage examples to License, with no development/testing
section. Meanwhile, the repo defines dev tooling dependencies and CI explicitly runs
ruff/pytest/mypy commands that contributors may want to run locally.

README.md[279-293]
pyproject.toml[42-56]
.github/workflows/ci.yml[10-20]
.github/workflows/ci.yml[22-36]
.github/workflows/ci.yml[37-47]
docs/getting-started.md[25-31]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The README removed the only explicit instructions for running local quality checks (pytest/ruff/mypy). CI still runs these commands, so contributors lack an obvious “how to reproduce CI locally” reference.

## Issue Context
- CI runs ruff check/format, pytest, and mypy.
- The project defines these tools under the `dev` optional dependency.

## Fix Focus Areas
- README.md[279-293]
- docs/getting-started.md[25-31]
- .github/workflows/ci.yml[10-20]
- .github/workflows/ci.yml[22-36]
- .github/workflows/ci.yml[37-47]
- pyproject.toml[42-56]

## Suggested change
Option A (minimal): re-add a `## Development` section to README with the exact CI commands.

Option B (preferred docs hygiene): add a `## Development` / `## Contributing` section to `docs/getting-started.md` listing the commands, and add a short link from README to that section.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

ⓘ The new review experience is currently in Beta. Learn more

[coderabbitai]

Warning

Rate limit exceeded

@ypriverol has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 12 minutes and 0 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b4cd36d5-df65-44a0-9390-f2398d69c5d8

📥 Commits

Reviewing files that changed from the base of the PR and between 7d1debf and 4477213.

📒 Files selected for processing (2)

• README.md
• pyproject.toml

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch dev

📝 Coding Plan

• Generate coding plan for human review comments

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}