squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Improve commit message style

Browse source
This commit is contained in:
Aleksey Kladov 2020-12-28 13:43:07 +03:00
parent 1d530756ed
commit 9c0c5f8e37
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/dev/style.md
View file

@ -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.