@@ -57,54 +57,8 @@ passes before merging any code changes.
57
57
Patch checklist
58
58
'''''''''''''''
59
59
60
- Along with running the tests, a simple automated patch checklist, ``patchcheck ``,
61
- guides a developer through the common patch generation checks. To run
62
- ``patchcheck ``:
63
-
64
- On *UNIX * (including Mac OS X)::
65
-
66
- make patchcheck
67
-
68
- On *Windows * (after any successful build)::
69
-
70
- python.bat Tools/scripts/patchcheck.py
71
-
72
- The automated patch checklist runs through:
73
-
74
- * Are there any whitespace problems in Python files?
75
- (using ``Tools/scripts/reindent.py ``)
76
- * Are there any whitespace problems in C files?
77
- * Are there any whitespace problems in the documentation?
78
- (using ``Tools/scripts/reindent-rst.py ``)
79
- * Has the documentation been updated?
80
- * Has the test suite been updated?
81
- * Has an entry under ``Misc/NEWS.d/next `` been added?
82
- * Has ``Misc/ACKS `` been updated?
83
- * Has ``configure `` been regenerated, if necessary?
84
- * Has ``pyconfig.h.in `` been regenerated, if necessary?
85
-
86
- The automated patch check doesn't actually *answer * all of these
87
- questions. Aside from the whitespace checks, the tool is
88
- a memory aid for the various elements that can go into
89
- making a complete patch.
90
-
91
-
92
- Commit Style
93
- ------------
94
-
95
- .. move this to pullrequest
96
-
97
- Once a change patch is ready and tested, it can be committed to the repository.
98
- We usually prefer to put a whole feature or bugfix into a single commit, but no
99
- more. In particular:
100
-
101
- * Do **not ** fix more than one issue in the same commit (except, of course, if
102
- one code change fixes all of them).
103
- * Do **not ** do cosmetic changes to unrelated code in the same commit as some
104
- feature/bugfix.
105
-
106
- It is of course okay to pile up several commits to one branch and merge them
107
- into another in one commit.
60
+ You should also :ref: `run patchcheck <patchcheck >` to perform a quick
61
+ sanity check on the changes.
108
62
109
63
110
64
Handling Others' Code
@@ -238,37 +192,6 @@ allowed here because news entries are meant to be as readable as possible
238
192
unprocessed.)
239
193
240
194
241
- Commit Messages
242
- ---------------
243
-
244
- .. move to pullrequest
245
-
246
- Every commit has a commit message to document why a change was made and to
247
- communicate that reason to other core developers. Python core developers have
248
- developed a standard way of formatting commit messages that everyone is
249
- expected to follow.
250
-
251
- Our usual convention mimics that used in news entries (it is actually common to
252
- start by pasting the news entry into the commit message). The only key
253
- difference when compared to a news entry is the inclusion of the issue number
254
- as the beginning of the commit message. Here is an example::
255
-
256
- bpo-42: the spam module is now more spammy.
257
-
258
- The spam module sporadically came up short on spam. This change
259
- raises the amount of spam in the module by making it more spammy.
260
-
261
- Thanks to Monty Python for the patch.
262
-
263
- The first line or sentence is meant to be a dense, to-the-point explanation
264
- of what the purpose of the commit is. If this is not enough detail for a commit,
265
- a new paragraph(s) can be added to explain in proper depth what has happened
266
- (detail should be good enough that a core developer reading the commit message
267
- understands the justification for the change). Also, if a non-core developer
268
- contributed to the resolution, it is good practice to credit them.
269
-
270
-
271
-
272
195
Working with Git _
273
196
=================
274
197
0 commit comments