DOC: split Contributing page #39367
State: closed

Splited original contributing.rst into 3 separate pages:
- Removed information for setting up an environment outside of Docker and created a new file for this purpose.
- Removed information for contributing to the codebase and created a new file for this purpose.
- Reformatted contributing.rst and renamed as contributing_documentation.rst (containing the remainder of information pertaining to documentation contributions).



Labels:
name: Docs

Comments:
see the docs build

```
/home/runner/work/pandas/pandas/doc/source/development/contributing_codebase.rst: WARNING: document isn't included in any toctree
/home/runner/work/pandas/pandas/doc/source/development/contributing_documentation.rst: WARNING: document isn't included in any toctree
/home/runner/work/pandas/pandas/doc/source/development/env_outside_docker.rst: WARNING: document isn't included in any toctree
```

IOW you are renaming but you have to change the referencing pages themselves. 
@David-dmh , this reference #39367, right? You should specify that on your PR message. This is the template to be used https://github.com/pandas-dev/pandas/blob/master/.github/PULL_REQUEST_TEMPLATE.md

About the changes you've made, I'd like to point a few things I've noticed: 

1) `doc/source/development/contributing_codebase.rst` should have only the content of the `Contributing to the code base` section, but it has everything from that section to the end of the file. `Contributing your changes to pandas` and `Tips for a successful pull request` shouldn't be there. 

2) The `doc/source/development/contributing_documentation.rst` file should have only the `Contributing to the documentation` part and **not** everything before (and after) that.

3) It looks like you renamed/deleted the `contributing.rst` file, but that file should still exist and it should remain basically the same.
Thank you for the guidelines, I'm working on making the changes.
Hi there sorry for asking, still very new to contributing to open source.  I need some guidelines on how to pass the checks, I have have made all changes I believe are needed based on the above comments, however I also notice the pre-commit is failing. Any tips appreciated to complete this PR. Thank you.
>  I need some guidelines on how to pass the checks

Sure, here you go: https://pandas.pydata.org/pandas-docs/dev/development/contributing.html#code-standards
About the checks, it also failed the docs build. You have to fix these problems too:
```
/home/runner/work/pandas/pandas/doc/source/development/contributing_documentation.rst:21: WARNING: duplicate label contributing, other instance in /home/runner/work/pandas/pandas/doc/source/development/contributing.rst
/home/runner/work/pandas/pandas/doc/source/development/contributing_codebase.rst: WARNING: document isn't included in any toctree
/home/runner/work/pandas/pandas/doc/source/development/contributing_documentation.rst: WARNING: document isn't included in any toctree
/home/runner/work/pandas/pandas/doc/source/development/env_outside_docker.rst: WARNING: document isn't included in any toctree
/home/runner/work/pandas/pandas/doc/source/development/contributing.rst:162: WARNING: undefined label: contributing.documentation
/home/runner/work/pandas/pandas/doc/source/development/contributing_codebase.rst:818: WARNING: undefined label: contributing.documentation
```
Currently I'm working on being able to build the docs. Three dependencies are not installing (bottleneck, fastparquet, python-snappy). I have made changes  in an attempt to rectify the doc build errors mentioned above. 
Hi @David-dmh - how are you trying to create your local development environment? IMO using miniconda is the most straightforward way. Anyway, if show your output, we can help debug
Thanks for getting back to me @MarcoGorelli . Firstly, as you can see the 'CI / Web and docs' test is failing. It has an output of: 
`build finished with problems, 5 warnings.
Error: Process completed with exit code 1.`

I am still having an issue regarding environment setup. I now tried with Miniconda and it still throws the following error: (this is after activating pandas-dev and calling `python setup.py build_ext -j 4` ).

`C:\Users\User\AppData\Local\Programs\Python\Python38\include\pyconfig.h(59): fatal error C1083: Cannot open include file: 'io.h': No such file or directory
C:\Users\User\AppData\Local\Programs\Python\Python38\include\pyconfig.h(59): fatal error C1083: Cannot open include file: 'io.h': No such file or directory
C:\Users\User\AppData\Local\Programs\Python\Python38\include\pyconfig.h(59): fatal error C1083: Cannot open include file: 'io.h': No such file or directory
error: command 'C:\\BuildTools\\VC\\Tools\\MSVC\\14.28.29333\\bin\\HostX86\\x64\\cl.exe' failed with exit status 2`

Did you install Build Tools for Visual Studio 2017?
Perhaps let's try solving the environment issue first then, can you write on the gitter channel providing information about your setup and what steps you followed?
Perhaps that is the issue, I installed the 2019 version. Will message via Gitter .

Hi @MarcoGorelli , still busy chipping away at this one. I have been trying to use docker and it successfully builds pandas after executing `docker build --tag pandas-yourname-env .`  I now need to just run `docker run -it --rm -v path-to-pandas-yourname:/home/pandas-yourname pandas-yourname-env`. 
Now this is likely a trivial issue but I am struggling to make sense of which paths to substitute into the above (to run the container and bind to the local forked repo)? I.e. Could you perhaps give a sample call? I can then just substitute my paths in. 
I think `path-to-pandas-yourname` should just be the path where you cloned the pandas repo locally

If you use VSCode or PyCharm (pro edition), they have their own ways for developing in remote containers, it might be easier like that https://code.visualstudio.com/docs/remote/containers
@gcmaciel I created a fresh PR #40130 with regards to this issue. Could you take a look at that code rather when reviewing and let me know of any fixes needed? 
Thanks @David-dmh - OK, I'll close this one in favour of #40130 (in the future, you can just add a new commit, you don't need to open a new PR), I'll aim to review it next week