cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Cordova Wiki] Update of "ContributorWorkflow" by MarcelKinard
Date Fri, 11 Jan 2013 17:56:48 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Cordova Wiki" for change notification.

The "ContributorWorkflow" page has been changed by MarcelKinard:
http://wiki.apache.org/cordova/ContributorWorkflow?action=diff&rev1=12&rev2=13

   
  ==== About Commit Messages ====
  
- You are highly encouraged to describe your {{{git commit}}} with enough detail for someone
else to understand it. In doing so, your commit message can consist of multiple lines. However,
it also is highly encouraged that the first line of your commit message not exceed 50 characters.
This is because some of the tooling that sits on top of git (such as the httpd apps that let
you browse the repo) assume that the first line is top-level summary that is 50 characters
or less. Thus there will be highlighting and truncating of the commit message using these
assumptions, and it will look weird if these assumptions are not kept. For example, here is
a good example of a commit message:
+ You are highly encouraged to describe your {{{git commit}}} with enough detail for someone
else to understand it. In doing so, your commit message can consist of multiple lines. However,
it also is highly encouraged that the first line of your commit message not exceed 50 characters.
This is because some of the tooling that sits on top of git (such as the httpd apps that let
you browse the repo) assume that the first line is top-level summary that is 50 characters
or less. Thus there will be highlighting and truncating of the commit message using these
assumptions, and it will look weird if these assumptions are not kept. And there should be
a blank line between the summary and any further detailed body. For example, here is a good
example of a commit message:
  
  {{{
  CB-1234: Fixed the whizbang widget

Mime
View raw message