Skip to content

Commit

Permalink
Add guidelines around changeset wording (keystonejs#1930)
Browse files Browse the repository at this point in the history
* Update contrib guide to include messages about changeset formatting

* Update CONTRIBUTING.md

Co-Authored-By: Mitchell Hamilton <mitchell@hamil.town>
  • Loading branch information
MadeByMike and emmatown authored Nov 7, 2019
1 parent 1bc4688 commit ea5171e
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,14 @@ A very useful description of the changes should be here.

You can have multiple changesets in a single PR. This will give you more granular changelogs, and is encouraged.

#### Changeset guidelines

We’re sometimes lovingly picky on the wording of our changesets because these end up in changelogs that people like you read. We want to try to get a consistent tone of voice while providing useful information to the reader.

In particular, please try to write in the past tense (e.g. "Added a new feature" rather than "Add a new feature") and write in complete sentences. This means proper capitalisation and punctuation, including full stops/periods at the end of sentences. We try to be terse when possible but if needed it's fine to write multiple lines including examples for changing APIs.

Thanks for your help with this.

### Release Guidelines

#### How to do a release
Expand Down

0 comments on commit ea5171e

Please sign in to comment.