From nobody Wed May 22 14:28:58 2024 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4VktwC19KDz5LpRX for ; Wed, 22 May 2024 14:28:59 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4VktwC0LsZz4HB4; Wed, 22 May 2024 14:28:59 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1716388139; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=XYrGAY8qUC5/a4gE6CULKz1+u8ymcJYsOsFjxmrXMGM=; b=EzNlj5LG40iExly6dxR6xoMWmbIbFgnpfES34zGHA+g/pWVWPH3Cci9/8HCyIBLGDzU3ac Ua29XR9VMDkvV+BVFnPB3N4FmXsdbGDC9A0EuNRyEKek1AXQYCrfIz2c3LdhhhCnzS6vEA PJU3cNRED9WSycBsU13JR0dSUNHCuE8puCW08qZE1qRrPVeJJGD70+fQvYUpqI7muoUDUP Es3VWD4c6b3h1gLQcL36K70ZD12xTtK6OjoDOe0uWpkvPEgbdaLUbjj4L3flpLyecfgDyo otLpP9e2uIjWuBbwZ+S8jVTCHtFhNnmGXSFaNskZ3hN7MpGMCAdWSh8CG2QehQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1716388139; a=rsa-sha256; cv=none; b=wPdysQWIPDxG8mzi3F6kdytqzy9N3sbogWHac/oy5YUOu18yJyIRNKzuoX3ExmzAjKYijh mx6SNdcOnL76E4I6IowzHv+jmkCr7hWIXRT2cu8p5zSYM0xgNb8I522aiY6V5z6ln5g+4H agGEFf30LmLdXLJaDlZpwa9iZEfxst98x9Kx3zU/TnIhhm0gdRfEXBTXnLrr8Vpea8zquG ZMd19+1sgNoDm8pSo6aztYlBSAVNBaS7W54MUlES3xcGDVhVFIbLN0w3me+GWbS39MjlWZ lTwrLsPRObNWTm5Vxl0xmj4cF0y7TMC+gqbElRGx97ah6b7wuspiMmbbDzwdow== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1716388139; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=XYrGAY8qUC5/a4gE6CULKz1+u8ymcJYsOsFjxmrXMGM=; b=PfZN8UIySFyqjaHVEV7q7JQ54Pgyz73Mg/gFz1aEa0jNOy0totfmG1snIeejnUIwZHl8ve r8K1NphTo+zOSeTOD6+qnuJ1BcQ0p7BNtvdAbfytG5g8toEdmrffX0/oSbo1hVKA6IT051 lMXLNWiYR5t3mZjqg0HFNzC8an2FO/ax8Qi9EtFFDY0sTnZwadmFSPQ68xE2oGpgit1oLN +Jz9jmk2t5T5WN8DaD2LTAa52zbxiWJMIYw9NzasXaK8/sjOiHwqvBe67Zv9CLC3ngoO33 efNn4sR3nK3vdNqkRC3DMsadXzRwwX4wLRBweRNL1o0I7Bc7KgiTTJS0xMUTbQ== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4VktwB6vNRz18Bl; Wed, 22 May 2024 14:28:58 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 44MESw5d002503; Wed, 22 May 2024 14:28:58 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 44MESwMo002500; Wed, 22 May 2024 14:28:58 GMT (envelope-from git) Date: Wed, 22 May 2024 14:28:58 GMT Message-Id: <202405221428.44MESwMo002500@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Ed Maste Subject: git: e4189484d4 - main - committers-guide: apply markup to sample bad commit message List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-doc-all@freebsd.org Sender: owner-dev-commits-doc-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: emaste X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: e4189484d46a70133e92220c8d9459e5c895cf8d Auto-Submitted: auto-generated The branch main has been updated by emaste: URL: https://cgit.FreeBSD.org/doc/commit/?id=e4189484d46a70133e92220c8d9459e5c895cf8d commit e4189484d46a70133e92220c8d9459e5c895cf8d Author: Ed Maste AuthorDate: 2024-05-20 00:01:57 +0000 Commit: Ed Maste CommitDate: 2024-05-22 14:25:50 +0000 committers-guide: apply markup to sample bad commit message Sponsored by: The FreeBSD Foundation --- documentation/content/en/articles/committers-guide/_index.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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.