Skip to content

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

Merged
merged 7 commits into from
Dec 16, 2022

Conversation

MarcoGorelli
Copy link
Member

Hey @noatamir , thoughts on this? I think it's clearer to split it up into 3 steps:

image

I've also removed some parts which are arguably unnecessary

@MarcoGorelli MarcoGorelli marked this pull request as draft December 9, 2022 09:24
@MarcoGorelli MarcoGorelli force-pushed the simplify-contributing-env branch 2 times, most recently from 33114f5 to c80e356 Compare December 9, 2022 09:26
@MarcoGorelli MarcoGorelli force-pushed the simplify-contributing-env branch from c80e356 to 2b9e661 Compare December 9, 2022 09:27
@MarcoGorelli
Copy link
Member Author

Just noticed #50144 - let's try to get that one in first

@MarcoGorelli MarcoGorelli marked this pull request as ready for review December 12, 2022 15:27
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``.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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``.

Copy link
Member Author

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

Copy link
Member

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)

Copy link
Member Author

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)

@mroeschke mroeschke added this to the 2.0 milestone Dec 13, 2022
Copy link
Member

@mroeschke mroeschke left a comment

Choose a reason for hiding this comment

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

LGTM

@MarcoGorelli
Copy link
Member Author

thanks! @natmokval seeing as you went through this not too long ago, reckon it makes it clearer for new contributors?

@MarcoGorelli MarcoGorelli merged commit 70eef55 into pandas-dev:main Dec 16, 2022
phofl pushed a commit to phofl/pandas that referenced this pull request Dec 17, 2022
* rewrite contributing environment guide

* clean up

* use ..note::

* them -> any file in pandas/_libs

Co-authored-by: MarcoGorelli <>
@MarcoGorelli
Copy link
Member Author

@meeseeksdev please backport to 1.5.x

@lumberbot-app
Copy link

lumberbot-app bot commented Dec 23, 2022

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout 1.5.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 70eef55e438823697515e834ee4ac350bdb0aaa7
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #50145: DOC restructure contributing environment guide'
  1. Push to a named branch:
git push YOURFORK 1.5.x:auto-backport-of-pr-50145-on-1.5.x
  1. Create a PR against branch 1.5.x, I would have named this PR:

"Backport PR #50145 on branch 1.5.x (DOC restructure contributing environment guide)"

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 Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

MarcoGorelli added a commit to MarcoGorelli/pandas that referenced this pull request Dec 23, 2022
MarcoGorelli added a commit to MarcoGorelli/pandas that referenced this pull request Dec 23, 2022
@MarcoGorelli
Copy link
Member Author

@meeseeksdev please backport to 1.5.x

meeseeksmachine pushed a commit to meeseeksmachine/pandas that referenced this pull request Dec 23, 2022
MarcoGorelli added a commit that referenced this pull request Dec 23, 2022
…ronment guide) (#50423)

Backport PR #50145: DOC restructure contributing environment guide

Co-authored-by: Marco Edward Gorelli <[email protected]>
@phofl phofl modified the milestones: 2.0, 1.5.3 Jan 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BUILD: No module named 'pandas._libs.interval' after building container from .devcontainer.json
3 participants