From 9c0c5f8e376c829cbcb89848efbad4810aa21e0a Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Mon, 28 Dec 2020 13:43:07 +0300 Subject: Improve commit message style --- docs/dev/style.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/dev/style.md b/docs/dev/style.md index 13c6a2a16..58b309379 100644 --- a/docs/dev/style.md +++ b/docs/dev/style.md @@ -63,6 +63,18 @@ After you are happy with the state of the code, please use [interactive rebase]( Avoid @mentioning people in commit messages and pull request descriptions(they are added to commit message by bors). Such messages create a lot of duplicate notification traffic during rebases. +If possible, write commit messages from user's perspective: + +``` +# Good +Goto definition works inside macros + +# Not as good +Use original span for FileId +``` + +This makes it easier to prepare a changelog. + ## Clippy We don't enforce Clippy. -- cgit v1.2.3