DOC Adding more details on how to contribute to the library #1131
Conversation
This file contains 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
rcap107
changed the title
TheooJ
reviewed
Oct 30, 2024
| and update the file ``skrub/tests/test_table_vectorizer.py`` so that it | ||
| takes into account the new transformer. | ||
|
|
||
| Additionally, you might have updated the dataframe API in |
There was a problem hiding this comment.
I wouldn't mention the dataframe API in skrub, you could say something like "have implemented some dispatched functions"
|
|
||
| .. code:: sh | ||
|
|
||
| pytest --doctest-modules skrub/path/to/file |
There was a problem hiding this comment.
Or just
Suggested change
| pytest --doctest-modules skrub/path/to/file | |
| pytest skrub/path/to/file |
as you wish
There was a problem hiding this comment.
Sometimes I also found it useful to test examples with python examples/my_example.py
|
|
||
| .. code:: sh | ||
|
|
||
| pixi run -e ci-py309-min-optional-deps pytest skrub/tests/path/to/test |
There was a problem hiding this comment.
To be honest pixi has a learning curve but this functionality is very helpful !
Co-authored-by: Théo Jolivet <[email protected]>
Co-authored-by: Théo Jolivet <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Very early and rough draft for some improvements to the page on how to contribute to skrub. Follow-up on #1130, and still very much a work in progress.
I added some of the points that I mentioned in the issue, and some examples. As I already said, this is an early draft that we could use for discussing what should be added, and wording and stuff.
I would like to add something more on writing doctests and maybe be more specific when it comes to CI, but I don't know enough about either do do that 😅
A checklist of the operations that should be performed for the PR (pre-commit, write tests, update the changelog etc.)
-[x] How to run tests using a specific environment with pixi on the local machine for debugging
-[x] How to check for code coverage on the local machine
-[x] How to check doctests
-[x] Some information on where the code for testing is, and how to structure tests
-[ ] The documentation style to use (numpydoc)