diff --git a/pandas/guide/_sources/pandas_pr.rst.txt b/pandas/guide/_sources/pandas_pr.rst.txt index df72295..6ab8560 100644 --- a/pandas/guide/_sources/pandas_pr.rst.txt +++ b/pandas/guide/_sources/pandas_pr.rst.txt @@ -24,7 +24,7 @@ where `` is for example `pandas.DataFrame.head`, 2. Visual validation of the docstring ------------------------------------- -The previous sprint validates things like the names of the sections, or +The previous script validates things like the names of the sections, or that there are dots, spaces, or blank lines in the right side. But does not validate for typos, unclear sentences, or other mistakes. To validate them, as well as the visualization of your docstring in the pandas website @@ -69,22 +69,40 @@ Then, follow the next steps: where `` is the file where you made your changes (in rare cases it could be more than one file). And `` is a short description of your changes, starting by "DOC:" (e.g. "DOC: Improved the -docsting of DataFrame.head()"). +docstring of DataFrame.head()"). -5. Push your changes to the sprint repository +5. Push your changes to the pandas repository --------------------------------------------- -Before sending the pull request to the pandas core developers, you will send -it to the sprint repository. Where more experienced contributors will review -it, and suggest changes if needed. +You are now ready to send a pull request to the pandas repository, to get your +changes reviewed. First, push your changes to your GitHub fork: | ``git push -u origin `` -Then, visit https://github.com/python-sprints/pandas in your browser, and click +Then, visit https://github.com/pandas-dev/pandas in your browser, and click on the "Compare & pull request" button in the yellow box above the repository files. -Once your changes are reviewed and approved, you will receive an email on how -to send the final pull request to pandas. +6. Update your pull request based on feedback +--------------------------------------------- + +The pull request will be reviewed by other sprint participants and pandas +developers. Based on those discussions, you might need to make additional +changes. After making those changes, make sure to again validate the docstring +(steps 1-3). + +To update the pull request, you can commit the changes and push again to +github. The pull request will automatically be updated: + + | ``git add `` + | ``git commit -m ""`` + | ``git push -u origin `` + +`` can now be a short indication of what has been updated +(e.g. "clarified the extended summary" or simply "updates based on feedback"). + +Once the reviewers are happy with the changes, a pandas developer will +merge your pull request (this may take some time when many pull requests +are opened during the sprint, so be patient with this). diff --git a/pandas/guide/_sources/pandas_setup.rst.txt b/pandas/guide/_sources/pandas_setup.rst.txt index 4e3f358..76c5558 100644 --- a/pandas/guide/_sources/pandas_setup.rst.txt +++ b/pandas/guide/_sources/pandas_setup.rst.txt @@ -37,6 +37,7 @@ version of pandas. Do not make them to a version downloaded from the Internet via pip, conda or a zip. To get the latest development version: + * Fork the `pandas repository `_ on GitHub by click on the top-right `Fork` button * In the terminal of your computer, in the directory where you want the copy of pandas source code, run: @@ -49,6 +50,7 @@ this document. Then, set the upstream remote, so you can fetch the updates from the pandas repository: + | ``cd `` | ``git remote add upstream https://github.com/pandas-dev/pandas`` 3. Set up a Python environment