docs: improve documentation for adding dependencies#659
docs: improve documentation for adding dependencies#659gsprochette wants to merge 1 commit intomainfrom
Conversation
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Comment @cursor review or bugbot run to trigger another review on this PR
Reviewed by Cursor Bugbot for commit 4704462. Configure here.
| strategy: | ||
| matrix: | ||
| python-version: ["3.11"] | ||
| name: ["base", 'lmharness', 'rapidata'] |
There was a problem hiding this comment.
Removing matrix key collapses three CI jobs into one
High Severity
The name array was removed from the matrix keys while the include entries still reference name. Since name is no longer a base matrix dimension, all three include entries only introduce new properties and get merged into the single base combination (python-version: "3.11"), with each subsequent entry overwriting the previous one. The result is that CI runs only one job (with the last entry's values: rapidata) instead of three separate jobs (base, lmharness, rapidata). The base and lmharness test suites silently stop running.
Reviewed by Cursor Bugbot for commit 4704462. Configure here.
4704462 to
d052f9c
Compare


Description
This PR moves and updates the documentation relative to adding new dependencies into pruna.
More specifically, it makes it easier for contributors to understand the steps for adding a new extra, and it also makes it easier for reviewers to direct them to the steps or one specific step.
Related Issue
Fixes #(issue number)
Type of Change
Testing
uv run pytest -m "cpu and not slow")For full setup and testing instructions, see the Contributing Guide.
Checklist
Thanks for contributing to Pruna! We're excited to review your work.
New to contributing? Check out our Contributing Guide for everything you need to get started.
First Prune (1-year OSS anniversary)
First Prune marks one year of Pruna’s open-source work. During the initiative window, qualifying merged contributions count toward First Prune. You can earn credits for our performance models via our API.
If you’d like your contribution to count toward First Prune, here’s how it works: