-
-
Notifications
You must be signed in to change notification settings - Fork 845
Update the setup and PR lifecycle pages #265
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.
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
ezio-melotti
merged 11 commits into
python:master
from
ezio-melotti:update-pr-lifecycle
Sep 28, 2017
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
5038a8f
Update the setup page and the quick guides.
ezio-melotti 25d8600
Working and markup tweaks.
ezio-melotti 22a51dc
Remove the "Tool Setup" section.
ezio-melotti 399b4b2
Rename the "Creating" section to "Introduction".
ezio-melotti 3ff87b2
Reorganize info about patchcheck.
ezio-melotti 345319a
Rename and move the "Preparation" section to "Making good PRs".
ezio-melotti 010e9ac
Fix headers levels (by rotating quotes).
ezio-melotti 0605bc2
Remove outdated comment.
ezio-melotti 4ca6432
Move and refactor the sections about commits.
ezio-melotti f008f8d
Fix markup and long lines.
ezio-melotti e343c17
Convert the step-by-step guide to a bullet list.
ezio-melotti File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -57,54 +57,8 @@ passes before merging any code changes. | |
Patch checklist | ||
''''''''''''''' | ||
|
||
Along with running the tests, a simple automated patch checklist, ``patchcheck``, | ||
guides a developer through the common patch generation checks. To run | ||
``patchcheck``: | ||
|
||
On *UNIX* (including Mac OS X):: | ||
|
||
make patchcheck | ||
|
||
On *Windows* (after any successful build):: | ||
|
||
python.bat Tools/scripts/patchcheck.py | ||
|
||
The automated patch checklist runs through: | ||
|
||
* Are there any whitespace problems in Python files? | ||
(using ``Tools/scripts/reindent.py``) | ||
* Are there any whitespace problems in C files? | ||
* Are there any whitespace problems in the documentation? | ||
(using ``Tools/scripts/reindent-rst.py``) | ||
* Has the documentation been updated? | ||
* Has the test suite been updated? | ||
* Has an entry under ``Misc/NEWS.d/next`` been added? | ||
* Has ``Misc/ACKS`` been updated? | ||
* Has ``configure`` been regenerated, if necessary? | ||
* Has ``pyconfig.h.in`` been regenerated, if necessary? | ||
|
||
The automated patch check doesn't actually *answer* all of these | ||
questions. Aside from the whitespace checks, the tool is | ||
a memory aid for the various elements that can go into | ||
making a complete patch. | ||
|
||
|
||
Commit Style | ||
------------ | ||
|
||
.. move this to pullrequest | ||
|
||
Once a change patch is ready and tested, it can be committed to the repository. | ||
We usually prefer to put a whole feature or bugfix into a single commit, but no | ||
more. In particular: | ||
|
||
* Do **not** fix more than one issue in the same commit (except, of course, if | ||
one code change fixes all of them). | ||
* Do **not** do cosmetic changes to unrelated code in the same commit as some | ||
feature/bugfix. | ||
|
||
It is of course okay to pile up several commits to one branch and merge them | ||
into another in one commit. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This has been moved to pullrequest and combined with the next red chunk. |
||
You should also :ref:`run patchcheck <patchcheck>` to perform a quick | ||
sanity check on the changes. | ||
|
||
|
||
Handling Others' Code | ||
|
@@ -238,37 +192,6 @@ allowed here because news entries are meant to be as readable as possible | |
unprocessed.) | ||
|
||
|
||
Commit Messages | ||
--------------- | ||
|
||
.. move to pullrequest | ||
|
||
Every commit has a commit message to document why a change was made and to | ||
communicate that reason to other core developers. Python core developers have | ||
developed a standard way of formatting commit messages that everyone is | ||
expected to follow. | ||
|
||
Our usual convention mimics that used in news entries (it is actually common to | ||
start by pasting the news entry into the commit message). The only key | ||
difference when compared to a news entry is the inclusion of the issue number | ||
as the beginning of the commit message. Here is an example:: | ||
|
||
bpo-42: the spam module is now more spammy. | ||
|
||
The spam module sporadically came up short on spam. This change | ||
raises the amount of spam in the module by making it more spammy. | ||
|
||
Thanks to Monty Python for the patch. | ||
|
||
The first line or sentence is meant to be a dense, to-the-point explanation | ||
of what the purpose of the commit is. If this is not enough detail for a commit, | ||
a new paragraph(s) can be added to explain in proper depth what has happened | ||
(detail should be good enough that a core developer reading the commit message | ||
understands the justification for the change). Also, if a non-core developer | ||
contributed to the resolution, it is good practice to credit them. | ||
|
||
|
||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This has been combined with the previous chunk. |
||
Working with Git_ | ||
================= | ||
|
||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This has been moved to the pullrequest page.