From 71b60a3102d8789c27913e97fa79c3b96eb43820 Mon Sep 17 00:00:00 2001 From: Martin von Zweigbergk Date: Mon, 7 Oct 2024 09:26:03 -0700 Subject: [PATCH] docs: clarify that commit messages start with a topic, not a component It's generally more useful to say something like "revset: use Self to refer to expressions of the same type" than "lib: use Self to refer to revset expressions of the same type ", so let's try to clarify that. --- docs/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing.md b/docs/contributing.md index b4d6842ee..f10386005 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -40,7 +40,7 @@ test and document. The commit message should describe the changes in the commit; the PR description can even be empty, but feel free to include a personal -message. We write commit messages in an affected component style and don't use +message. We start the commit message with `: ` and don't use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). This means if you modified a command in the CLI, use its name as the topic, e.g `next/prev: ` or `conflicts: `. We don't