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 Thu, 30 May 2013 20:11:12 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:
https://wiki.apache.org/cordova/ContributorWorkflow?action=diff&rev1=21&rev2=22

Comment:
added brief explanation of svngit2jira

  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
+ [CB-1234] Fixed the whizbang widget
  
  - added more sanity checking in the build script.
  - fixed the API to return the correct value in the scenario where there 
@@ -134, +134 @@

  between paragraphs.
  }}}
  
- Note that the first line does two things: (1) it is less than 50 characters. Subsequent
lines after the first may exceed 50 characters. (2) it references a Jira issue by its id (CB-1234).
Commonly, there should be a Jira issue open for defects and new features, and it is good practice
for commits to point to the Jira issue they are addressing. And vice versa, you should add
a comment to the Jira issue referencing the commit id(s) that contain your work.
+ Note that the first line does two things: (1) it is less than 50 characters. Subsequent
lines after the first may exceed 50 characters. (2) it references a Jira issue by its id (CB-1234).
Commonly, there should be a Jira issue open for defects and new features, and it is good practice
for commits to point to the Jira issue they are addressing. And vice versa, you should add
a comment to the Jira issue referencing the commit id(s) that contain your work. By adding
the Jira number in square brackets in the commit message, there will be an [[http://www.apache.org/dev/svngit2jira.html|automatic
comment]] added to the Jira item with the commit id.
  
  Long commit messages are not necessary, especially if there is a reference to a Jira item.
More good advice on this topic is in the [[http://git-scm.com/book/ch5-2.html#Commit-Guidelines|Git
book]].
   

Mime
View raw message