-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC restructure contributing environment guide #50145
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC restructure contributing environment guide #50145
Conversation
33114f5
to
c80e356
Compare
c80e356
to
2b9e661
Compare
Just noticed #50144 - let's try to get that one in first |
nor any existing Python installation. | ||
|
||
Note that you will need to repeat this step each time the C extensions change, for example | ||
if you modified them or if you did a fetch and merge from ``upstream/main``. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if you modified them or if you did a fetch and merge from ``upstream/main``. | |
if you modified any file in `pandas/_libs` or if you did a fetch and merge from ``upstream/main``. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there's also some in pandas/io
though
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh I didn't know there's some sas cython code there (I think that should be moved to pandas/_libs
at some point).
Mainly wanted to clarify here what files constitute C extensions
(pyx files)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK I've gone with your suggestion (it does say "for example", so it's fine if it's not exhaustive, especially if the sas files should be moved to pandas/_libs too)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
thanks! @natmokval seeing as you went through this not too long ago, reckon it makes it clearer for new contributors? |
* rewrite contributing environment guide * clean up * use ..note:: * them -> any file in pandas/_libs Co-authored-by: MarcoGorelli <>
@meeseeksdev please backport to 1.5.x |
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon! Remember to remove the If these instructions are inaccurate, feel free to suggest an improvement. |
@meeseeksdev please backport to 1.5.x |
…ronment guide) (#50423) Backport PR #50145: DOC restructure contributing environment guide Co-authored-by: Marco Edward Gorelli <[email protected]>
doc/source/whatsnew/vX.X.X.rst
file if fixing a bug or adding a new feature.Hey @noatamir , thoughts on this? I think it's clearer to split it up into 3 steps:
I've also removed some parts which are arguably unnecessary