Skip to content

Commit 9f2b215

Browse files
authored
Use emoji to illustrate good and bad example commit messages (python#1235)
1 parent 73842ea commit 9f2b215

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

getting-started/git-boot-camp.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ Solution:
401401

402402
2. Apply the patch::
403403

404-
git apply /path/to/patch.diff
404+
$ git apply /path/to/patch.diff
405405

406406
If there are errors, update to a revision from when the patch was
407407
created and then try the ``git apply`` again::
@@ -489,7 +489,7 @@ in place of the gray ``Enable auto-merge`` button you will find a green
489489

490490
In either case, adjust and clean up the commit message.
491491

492-
Here's an example of a **good** commit message:
492+
Here's an example of a **good** commit message:
493493

494494
.. code-block:: text
495495
@@ -498,7 +498,7 @@ Here's an example of a **good** commit message:
498498
* Add method A to the spam module
499499
* Update the documentation of the spam module
500500
501-
Here's an example of a **bad** commit message:
501+
Here's an example of a **bad** commit message:
502502

503503
.. code-block:: text
504504
@@ -573,7 +573,7 @@ The above commands will print out the hash of the commit containing
573573
When formatting the commit message for a backport commit: leave the original
574574
one as is and delete the number of the backport pull request.
575575

576-
Example of good backport commit message:
576+
Example of good backport commit message:
577577

578578
.. code-block:: text
579579
@@ -584,7 +584,7 @@ Example of good backport commit message:
584584
585585
(cherry picked from commit 62adc55)
586586
587-
Example of bad backport commit message:
587+
Example of bad backport commit message:
588588

589589
.. code-block:: text
590590

index.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,9 @@ instructions please see the :ref:`setup guide <setup>`.
116116

117117
7. Push the branch on your fork on GitHub and :ref:`create a pull request
118118
<pullrequest>`. Include the issue number using ``gh-NNNN`` in the
119-
pull request description. For example::
119+
pull request description. For example:
120+
121+
.. code-block:: text
120122
121123
gh-12345: Fix some bug in spam module
122124

0 commit comments

Comments
 (0)