Skip to content

Update submit PR guide #39

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.

Sign up for GitHub

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 1 commit into from
Mar 1, 2018
Merged

Update submit PR guide #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 27 additions & 9 deletions pandas/guide/_sources/pandas_pr.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ where `<your-function-or-method>` 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
Expand Down Expand Up @@ -69,22 +69,40 @@ Then, follow the next steps:
where `<modified-file(s)>` is the file where you made your changes (in rare
cases it could be more than one file). And `<commit-message>` 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 <your-branch-name>``

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
---------------------------------------------
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added this section to explicitly explain how to update a PR, if that looks OK (sometimes people not familiar with this then open a new PR or so).


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 <modified-file(s)>``
| ``git commit -m "<commit-message>"``
| ``git push -u origin <your-branch-name>``

`<commit-message>` 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).
2 changes: 2 additions & 0 deletions pandas/guide/_sources/pandas_setup.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/pandas-dev/pandas>`_ 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:

Expand All @@ -49,6 +50,7 @@ this document.
Then, set the upstream remote, so you can fetch the updates from the pandas
repository:

| ``cd <pandas-dir>``
| ``git remote add upstream https://github.com/pandas-dev/pandas``

3. Set up a Python environment
Expand Down