From 2150aff0d877d74c211baf1c330392c9b82c8654 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20CORTIER?= Date: Wed, 7 Sep 2022 10:22:49 -0400 Subject: [PATCH] Add good defaults rulers when editing git messages Around 50 columns for the summary is good because it is often used as heading or as subject in emails. 72 columns for the body is generally good because some tools do not wrap long lines (`git log` with pager `less` is a good example). Helix's `:reflow` command is really good to help with the second point. Linux kernel documentation says: > For these reasons, the ``summary`` must be no more than 70-75 > characters, and it must describe both what the patch changes, as well > as why the patch might be necessary. It is challenging to be both > succinct and descriptive, but that is what a well-written summary > should do. Source: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst#n627 tpope: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html Commit message style guide for Git: https://commit.style/ --- languages.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/languages.toml b/languages.toml index d3051377955b7..5262ed51f7691 100644 --- a/languages.toml +++ b/languages.toml @@ -972,6 +972,7 @@ roots = [] file-types = ["COMMIT_EDITMSG"] comment-token = "#" indent = { tab-width = 2, unit = " " } +rulers = [50, 72] [[grammar]] name = "git-commit"