aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEd Maste <emaste@FreeBSD.org>2024-05-20 00:01:57 +0000
committerEd Maste <emaste@FreeBSD.org>2024-05-22 14:25:50 +0000
commite4189484d46a70133e92220c8d9459e5c895cf8d (patch)
tree2133a86197c224a99e56fe949ff21593a032be86
parent8f4754a9a6ee8f2503cfb68d14afa99b17729e7f (diff)
downloaddoc-e4189484d4.tar.gz
doc-e4189484d4.zip
committers-guide: apply markup to sample bad commit message
Sponsored by: The FreeBSD Foundation
-rw-r--r--documentation/content/en/articles/committers-guide/_index.adoc2
1 files changed, 1 insertions, 1 deletions
diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc
index 1106e62635..8eda3085f3 100644
--- a/documentation/content/en/articles/committers-guide/_index.adoc
+++ b/documentation/content/en/articles/committers-guide/_index.adoc
@@ -2412,7 +2412,7 @@ This section contains some suggestions and traditions for how commit logs are fo
=== Why are commit messages important?
When you commit a change in Git, Subversion, or another version control system (VCS), you're prompted to write some text describing the commit -- a commit message.
-How important is this commit message? Should you spend some significant effort writing it? Does it really matter if you write simply fixed a bug?
+How important is this commit message? Should you spend some significant effort writing it? Does it really matter if you write simply `fixed a bug`?
Most projects have more than one developer and last for some length of time.
Commit messages are a very important method of communicating with other developers, in the present and for the future.