Skip to content

Commit

Permalink
Use emoji to illustrate good and bad example commit messages (#1235)
Browse files Browse the repository at this point in the history
  • Loading branch information
hugovk committed Dec 1, 2023
1 parent 73842ea commit 9f2b215
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
10 changes: 5 additions & 5 deletions getting-started/git-boot-camp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ Solution:

2. Apply the patch::

git apply /path/to/patch.diff
$ git apply /path/to/patch.diff

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

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

Here's an example of a **good** commit message:
Here's an example of a **good** commit message:

.. code-block:: text
Expand All @@ -498,7 +498,7 @@ Here's an example of a **good** commit message:
* Add method A to the spam module
* Update the documentation of the spam module
Here's an example of a **bad** commit message:
Here's an example of a **bad** commit message:

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

Example of good backport commit message:
Example of good backport commit message:

.. code-block:: text
Expand All @@ -584,7 +584,7 @@ Example of good backport commit message:
(cherry picked from commit 62adc55)
Example of bad backport commit message:
Example of bad backport commit message:

.. code-block:: text
Expand Down
4 changes: 3 additions & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,9 @@ instructions please see the :ref:`setup guide <setup>`.

7. Push the branch on your fork on GitHub and :ref:`create a pull request
<pullrequest>`. Include the issue number using ``gh-NNNN`` in the
pull request description. For example::
pull request description. For example:

.. code-block:: text
gh-12345: Fix some bug in spam module
Expand Down

0 comments on commit 9f2b215

Please sign in to comment.