docs: updated contributing with test_plugin install #3345
Merged
+2
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
ugh failing tests - do I need to do anything about these? Didn't have local failures. |
MarcoGorelli
approved these changes
Dec 9, 2025
Contributor
Author
|
yes I think you're right, will try to add something without breaking the clarity. |
ym-pett
commented
Dec 9, 2025
CONTRIBUTING.md
Outdated
| Static typing is run separately from `pre-commit`, as it's quite slow. Assuming you followed all the instructions above, you can run it with `make typing`. | ||
| Finally, if you've had to update the install of Narwhals after changes, it can happen that a part of the testing functionality is no longer available, and you will see `pytest` errors around the `test_plugin`. This can be fixed by separately re-installing by running `uv pip install -e ./test-plugin`. | ||
Contributor
Author
There was a problem hiding this comment.
what do you think of this? Is it too wordy?
Contributor
Author
There was a problem hiding this comment.
Ps: annoyingly, the 'conversation' view shows the old version of the edits but the file view has the latest version.
Member
|
thanks @ym-pett ! i found that we can simply combine the install steps so i've done that |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I had difficulties following local reinstallation of Narwhals. I wonder if it would be worth adding to the
Contributingfile for less experienced users? I've tried to keep it as minimal as possible as I didn't want to break the flow.First I tried having it as a bullet point of the tldr installation, but that didn't seem right, as it's not a necessary first step. I've left it at 'may need to' to hedge for the fact that this might get fixed sometime in the future and we might forget to fix the contributing, but happy to change.
What type of PR is this? (check all applicable)
Related issues
Checklist