@@ -24,7 +24,7 @@ where `<your-function-or-method>` is for example `pandas.DataFrame.head`,
24
24
2. Visual validation of the docstring
25
25
-------------------------------------
26
26
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
28
28
that there are dots, spaces, or blank lines in the right side. But does
29
29
not validate for typos, unclear sentences, or other mistakes. To validate
30
30
them, as well as the visualization of your docstring in the pandas website
@@ -69,22 +69,40 @@ Then, follow the next steps:
69
69
where `<modified-file(s)> ` is the file where you made your changes (in rare
70
70
cases it could be more than one file). And `<commit-message> ` is a short
71
71
description of your changes, starting by "DOC:" (e.g. "DOC: Improved the
72
- docsting of DataFrame.head()").
72
+ docstring of DataFrame.head()").
73
73
74
- 5. Push your changes to the sprint repository
74
+ 5. Push your changes to the pandas repository
75
75
---------------------------------------------
76
76
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.
80
79
81
80
First, push your changes to your GitHub fork:
82
81
83
82
| ``git push -u origin <your-branch-name>``
84
83
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
86
85
on the "Compare & pull request" button in the yellow box above the repository
87
86
files.
88
87
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).
0 commit comments