Skip to content

Commit 536337a

Browse files
committed
Improve pull request guidelines
1 parent 4614d17 commit 536337a

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

CONTRIBUTING.rst

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,29 @@ feature branch.
132132

133133
Do not squash your commits after you have submitted a pull request, as this
134134
erases context during the review.
135-
The commits will be squashed commits when the pull request is merged.
135+
The commits will be squashed when the pull request is merged.
136136

137137
To keep you forked repository clean, we suggest deleting branches for
138138
once the Pull Requests (PRs) are accepted and merged.
139139

140+
Once you've created a pull request, you can push commits from your topic branch
141+
to add them to your existing pull request.
142+
These commits will appear in chronological order within your pull request and
143+
the changes will be visible in the "Files changed" tab.
144+
145+
Other contributors can review your proposed changes, add review comments,
146+
contribute to the pull request discussion, and even add commits to the pull
147+
request.
148+
149+
**Important:** each PR should should only address a single objective
150+
(e.g. fix a bug, improve documentation, etc).
151+
Pushing changes to an open PR that are outside its objective are highly
152+
discouraged.
153+
Under this circumstances, the recommended way to proceed is creating a new PR
154+
for changes, clearly explaining their goal.
155+
156+
157+
140158
Core developer guidelines
141159
~~~~~~~~~~~~~~~~~~~~~~~~~
142160

@@ -210,6 +228,7 @@ open source projects:
210228
`License <https://github.com/ARM-DOE/pyart/blob/master/LICENSE.txt>`_.
211229
* mypy_: Copyright (c) 2015-2016 Jukka Lehtosalo and contributors.
212230
`MIT License <https://github.com/python/mypy/blob/master/LICENSE>`_.
231+
* Official github documentation (https://help.github.com)
213232

214233
.. _Py-Art: https://github.com/ARM-DOE/pyart
215234
.. _mypy: https://github.com/python/mypy

0 commit comments

Comments
 (0)