docs: Tweak commit message guidelines.

- I fixed a typo with "lowerecase"
- I elaborated on the prefix before elaborating
  on the rest of the message (i.e. went in correct
  order).
- I split out the provision example (since we
  talk about it some depth).
- I added more positive examples.
- I removed the distracting italics around the
  good commit messages.
- I moved the "gather_subscriptions" commit to
  the bottom of the list, since we elaborate
  on that below the list.
This commit is contained in:
Steve Howell 2020-02-24 12:41:16 +00:00 committed by Tim Abbott
parent f68e91e6e1
commit 59b047c862
1 changed files with 16 additions and 6 deletions

View File

@ -100,17 +100,27 @@ The first line of the commit message is the **summary**. The summary:
### Good summaries:
Notice how the first example starts with a capital letter "**I**", ends with a
period "**.**", and the name of the subsystem starts with a lowerecase letter
"**p**" followed by a colon "**:**" and a single space **" "** after the colon.
Below is an example of a good commit summary line. It starts with the
prefix "provision:", using lowercase "**p**". Next, "Improve performance of
install npm." starts with a capital "**I**", uses imperative tense,
and ends with a period.
> *provision: Improve performance of installing npm.*
> *zjsunit: Fix running stream_data and node tests individually.*
Here are some more positive examples:
> *gather_subscriptions: Fix exception handling bad input.*
> channel: Discard all HTTP responses while reloading.
> integrations: Add GitLab integration.
> typeahead: Convert to ES6 module.
> tests: Compile Handlebars templates with source maps.
> blueslip: Add feature to time common operations.
> gather_subscriptions: Fix exception handling bad input.
> *integrations: Add GitLab integration.*
Compare "*gather_subscriptions: Fix exception handling bad input.*" with: