development/github-desktop
development/github-desktop
1
0
Fork 0
mirror of https://github.com/desktop/desktop synced 2024-09-13 21:31:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

add verbiage section

Browse source
This commit is contained in:
evelyn masso 2020-01-29 10:12:57 -05:00
parent fee5939242
commit d840914a0c
1 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/process/writing-release-notes.md
View file

@ -53,7 +53,23 @@ For example:
but **not** this
```
[Added] Adding integration for Xcode as external editor - #8255
[Added] Adding external editor integration for Xcode - #8255
```
### Verbiage
Although it is often tempting to use the tag prefix as the first word of the release note, we prefer to keep the release note description separate from the tag so that the description is readable by itself.
For example, we might say:
```
[Improved] Always fast forward recent branches after fetch - #7761
```
but **not**:
```
[Improved] Branch fast-forwarding after fetch - #7761
```
## Tags 🛄