From f5bd7bb0a0d382b73c92249073b52e391a190a65 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Fri, 1 Dec 2023 17:02:15 +0200 Subject: [PATCH 1/2] Use emoji to illustrate good and bad commits --- getting-started/git-boot-camp.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/getting-started/git-boot-camp.rst b/getting-started/git-boot-camp.rst index 2bd4c86584..a674ecca20 100644 --- a/getting-started/git-boot-camp.rst +++ b/getting-started/git-boot-camp.rst @@ -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 @@ -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 @@ -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 @@ -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 From 3faaa154e38c0b2fd6e3cb09495546c0c8f5780b Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Fri, 1 Dec 2023 17:02:27 +0200 Subject: [PATCH 2/2] Fix formatting --- getting-started/git-boot-camp.rst | 2 +- index.rst | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/getting-started/git-boot-camp.rst b/getting-started/git-boot-camp.rst index a674ecca20..fd080320e7 100644 --- a/getting-started/git-boot-camp.rst +++ b/getting-started/git-boot-camp.rst @@ -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:: diff --git a/index.rst b/index.rst index 0621180e75..7799779634 100644 --- a/index.rst +++ b/index.rst @@ -116,7 +116,9 @@ instructions please see the :ref:`setup guide `. 7. Push the branch on your fork on GitHub and :ref:`create a pull request `. 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