aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAleksey Kladov <[email protected]>2020-12-28 10:43:07 +0000
committerAleksey Kladov <[email protected]>2020-12-28 10:43:07 +0000
commit9c0c5f8e376c829cbcb89848efbad4810aa21e0a (patch)
tree33948b933b0248246d4af100ca4a270bc9b00d2f /docs
parent1d530756ed7ba175ec32ff71247072798dc9a748 (diff)
Improve commit message style
Diffstat (limited to 'docs')
-rw-r--r--docs/dev/style.md12
1 files changed, 12 insertions, 0 deletions
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](
63Avoid @mentioning people in commit messages and pull request descriptions(they are added to commit message by bors). 63Avoid @mentioning people in commit messages and pull request descriptions(they are added to commit message by bors).
64Such messages create a lot of duplicate notification traffic during rebases. 64Such messages create a lot of duplicate notification traffic during rebases.
65 65
66If possible, write commit messages from user's perspective:
67
68```
69# Good
70Goto definition works inside macros
71
72# Not as good
73Use original span for FileId
74```
75
76This makes it easier to prepare a changelog.
77
66## Clippy 78## Clippy
67 79
68We don't enforce Clippy. 80We don't enforce Clippy.