Skip to content

Commit 3211dcc

Browse files
jorisvandenbosschedatapythonista
authored andcommitted
Update submit PR guide (#39)
1 parent 199d917 commit 3211dcc

File tree

2 files changed

+29
-9
lines changed

2 files changed

+29
-9
lines changed

pandas/guide/_sources/pandas_pr.rst.txt

+27-9
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ where `<your-function-or-method>` is for example `pandas.DataFrame.head`,
2424
2. Visual validation of the docstring
2525
-------------------------------------
2626

27-
The previous sprint validates things like the names of the sections, or
27+
The previous script validates things like the names of the sections, or
2828
that there are dots, spaces, or blank lines in the right side. But does
2929
not validate for typos, unclear sentences, or other mistakes. To validate
3030
them, as well as the visualization of your docstring in the pandas website
@@ -69,22 +69,40 @@ Then, follow the next steps:
6969
where `<modified-file(s)>` is the file where you made your changes (in rare
7070
cases it could be more than one file). And `<commit-message>` is a short
7171
description of your changes, starting by "DOC:" (e.g. "DOC: Improved the
72-
docsting of DataFrame.head()").
72+
docstring of DataFrame.head()").
7373

74-
5. Push your changes to the sprint repository
74+
5. Push your changes to the pandas repository
7575
---------------------------------------------
7676

77-
Before sending the pull request to the pandas core developers, you will send
78-
it to the sprint repository. Where more experienced contributors will review
79-
it, and suggest changes if needed.
77+
You are now ready to send a pull request to the pandas repository, to get your
78+
changes reviewed.
8079

8180
First, push your changes to your GitHub fork:
8281

8382
| ``git push -u origin <your-branch-name>``
8483
85-
Then, visit https://github.com/python-sprints/pandas in your browser, and click
84+
Then, visit https://github.com/pandas-dev/pandas in your browser, and click
8685
on the "Compare & pull request" button in the yellow box above the repository
8786
files.
8887

89-
Once your changes are reviewed and approved, you will receive an email on how
90-
to send the final pull request to pandas.
88+
6. Update your pull request based on feedback
89+
---------------------------------------------
90+
91+
The pull request will be reviewed by other sprint participants and pandas
92+
developers. Based on those discussions, you might need to make additional
93+
changes. After making those changes, make sure to again validate the docstring
94+
(steps 1-3).
95+
96+
To update the pull request, you can commit the changes and push again to
97+
github. The pull request will automatically be updated:
98+
99+
| ``git add <modified-file(s)>``
100+
| ``git commit -m "<commit-message>"``
101+
| ``git push -u origin <your-branch-name>``
102+
103+
`<commit-message>` can now be a short indication of what has been updated
104+
(e.g. "clarified the extended summary" or simply "updates based on feedback").
105+
106+
Once the reviewers are happy with the changes, a pandas developer will
107+
merge your pull request (this may take some time when many pull requests
108+
are opened during the sprint, so be patient with this).

pandas/guide/_sources/pandas_setup.rst.txt

+2
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ version of pandas. Do not make them to a version downloaded from the Internet
3737
via pip, conda or a zip.
3838

3939
To get the latest development version:
40+
4041
* Fork the `pandas repository <https://github.com/pandas-dev/pandas>`_ on GitHub by click on the top-right `Fork` button
4142
* In the terminal of your computer, in the directory where you want the copy of pandas source code, run:
4243

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

53+
| ``cd <pandas-dir>``
5254
| ``git remote add upstream https://github.com/pandas-dev/pandas``
5355
5456
3. Set up a Python environment

0 commit comments

Comments
 (0)