Skip to content

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

Closed
afeld opened this issue Jan 24, 2021 · 8 comments · Fixed by #40130
Closed

DOC: split Contributing page #39367

afeld opened this issue Jan 24, 2021 · 8 comments · Fixed by #40130

Comments

@afeld
Copy link
Member

afeld commented Jan 24, 2021

Location of the documentation

https://pandas.pydata.org/docs/development/contributing.html

Documentation problem

The page is long and covers a lot:

  • Environment setup
  • The mechanics of contributing to code and docs
  • Code standards

Suggested fix for documentation

I suggest streamlining the primary Contributing page to be about the basic workflow, splitting out sub-pages for:

  • Setting up an environment outside of Docker
    • Installing a C compiler
    • Creating a Python environment
    • Creating a Python environment (pip)
  • Contributing to the code base
  • Contributing to the documentation
@afeld afeld added Docs Needs Triage Issue that has not been reviewed by a pandas team member good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Jan 24, 2021
@ShrillShrestha
Copy link

ShrillShrestha commented Jan 24, 2021

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.

@MarcoGorelli
Copy link
Member

Hi @ShrillShrestha - the contributing file is here doc/source/development/contributing.rst

@ShrillShrestha
Copy link

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?

@David-dmh
Copy link

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?

@MarcoGorelli
Copy link
Member

The suggestion is to split out

    Setting up an environment outside of Docker
        Installing a C compiler
        Creating a Python environment
        Creating a Python environment (pip)
    Contributing to the code base
    Contributing to the documentation

to be separate pages, rather than all being part of the same contributing.rst file

@Marcopollom
Copy link

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).

@David-dmh
Copy link

take

@David-dmh
Copy link

Just submitted a PR

David-dmh pushed a commit to David-dmh/pandas that referenced this issue Mar 1, 2021
David-dmh pushed a commit to David-dmh/pandas that referenced this issue Mar 30, 2021
David-dmh pushed a commit to David-dmh/pandas that referenced this issue Apr 1, 2021
MarcoGorelli added a commit that referenced this issue Apr 4, 2021
* #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]>
vladu pushed a commit to vladu/pandas that referenced this issue Apr 5, 2021
* 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]>
JulianWgs pushed a commit to JulianWgs/pandas that referenced this issue Jul 3, 2021
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants