-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: split Contributing page #39367
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
Comments
Hi @afeld, I am a beginner and am learning to contribute. I haven't use pandas before, but this issue seems interesting. If you can guide me and provide more information regarding the issue (i.e which files to change, how to change), maybe I can resolve it. |
Hi @ShrillShrestha - the contributing file is here doc/source/development/contributing.rst |
Thanks, @MarcoGorelli for responding. I am kind of new to .rst files. Can you refer me to some resources I can start with to resolve this issue? |
Hi @MarcoGorelli, new to contributing but keen to help out. Am I understanding correctly that you do not intend to change to contents of the contributing page but rather to reorder the heading in a more logical manner? |
The suggestion is to split out
to be separate pages, rather than all being part of the same |
Hello @MarcoGorelli, I'm new to contributing but am looking forward to making these changes. Do you know if a Pull Request been made yet (I checked the PR logs but didn't see any). |
take |
Just submitted a PR |
* #39367 DOC: split contributing.rst * DOC: attempt to fix broken refs * DOC: attempt to fix broken refs * DOC: attempt to fix broken refs * DOC: attempt to fix broken refs * DOC: fix spelling * DOC: fix spelling * DOC: remove trailing whitespace * Update doc/source/development/env_outside_docker.rst Co-authored-by: Daniel Saxton <[email protected]> * DOC: restructure enviroment setup as new file * DOC: updated files * DOC: fix link Co-authored-by: Daniel Saxton <[email protected]> Co-authored-by: Marco Gorelli <[email protected]>
* pandas-dev#39367 DOC: split contributing.rst * DOC: attempt to fix broken refs * DOC: attempt to fix broken refs * DOC: attempt to fix broken refs * DOC: attempt to fix broken refs * DOC: fix spelling * DOC: fix spelling * DOC: remove trailing whitespace * Update doc/source/development/env_outside_docker.rst Co-authored-by: Daniel Saxton <[email protected]> * DOC: restructure enviroment setup as new file * DOC: updated files * DOC: fix link Co-authored-by: Daniel Saxton <[email protected]> Co-authored-by: Marco Gorelli <[email protected]>
* pandas-dev#39367 DOC: split contributing.rst * DOC: attempt to fix broken refs * DOC: attempt to fix broken refs * DOC: attempt to fix broken refs * DOC: attempt to fix broken refs * DOC: fix spelling * DOC: fix spelling * DOC: remove trailing whitespace * Update doc/source/development/env_outside_docker.rst Co-authored-by: Daniel Saxton <[email protected]> * DOC: restructure enviroment setup as new file * DOC: updated files * DOC: fix link Co-authored-by: Daniel Saxton <[email protected]> Co-authored-by: Marco Gorelli <[email protected]>
Location of the documentation
https://pandas.pydata.org/docs/development/contributing.html
Documentation problem
The page is long and covers a lot:
Suggested fix for documentation
I suggest streamlining the primary Contributing page to be about the basic workflow, splitting out sub-pages for:
Installing a C compiler
Creating a Python environment
Creating a Python environment (pip)
Contributing to the code base
Contributing to the documentation
The text was updated successfully, but these errors were encountered: