Skip to content

Use emoji to illustrate good and bad example commit messages #1235

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.

Sign up for GitHub

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
hugovk merged 2 commits into from
Dec 1, 2023
Merged

Use emoji to illustrate good and bad example commit messages #1235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f5bd7bb
Use emoji to illustrate good and bad commits
hugovk Dec 1, 2023
3faaa15
Fix formatting
hugovk Dec 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions getting-started/git-boot-camp.rst
View file
Open in desktop
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
View file
Open in desktop
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