Skip to content

docs: improve documentation for adding dependencies#659

Open
gsprochette wants to merge 1 commit intomainfrom
docs/improve-documentation-for-adding-dependencies
Open

docs: improve documentation for adding dependencies#659
gsprochette wants to merge 1 commit intomainfrom
docs/improve-documentation-for-adding-dependencies

Conversation

@gsprochette
Copy link
Copy Markdown
Collaborator

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactor (no functional change)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Testing

  • I added or updated tests covering my changes
  • Existing tests pass locally (uv run pytest -m "cpu and not slow")

For full setup and testing instructions, see the Contributing Guide.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code, especially for agent-assisted changes
  • I updated the documentation where necessary

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.

Note:

  • Draft PRs or PRs without a clear and detailed overview may be delayed.
  • Please mark your PR as Ready for Review and ensure the sections above are filled out.
  • Contributions that are entirely AI-generated without meaningful human review are discouraged.

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:

  • Initiative window: First Prune starts on March 31.
  • Issue assignment: For your PR to count toward First Prune, the related issue must be assigned to the contributor opening the PR. Issues are labeled with first-prune.
  • Open for review: Please open your PR and mark it ready for review by April 30 (end of April).
  • Review priority: We’ll make our best effort to review quickly any PR that is open and has a review request before April 30.
  • Credits: Each qualifying merged PR earns 30 credits. We’ll be in touch after all qualifying PRs for First Prune have been merged.
  • To get started: Have a look at all models. You’ll need to sign up on the dashboard before you can redeem your credits.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ 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']
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 4704462. Configure here.

@gsprochette gsprochette force-pushed the docs/improve-documentation-for-adding-dependencies branch from 4704462 to d052f9c Compare May 9, 2026 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant