cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <>
Subject [Cordova Wiki] Update of "ContributorWorkflow" by MarcelKinard
Date Mon, 07 Oct 2013 16:37:42 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:

add further explanation about commit messages for cordova-js repo (to match CommitterWorkflow)

  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 to the front of the commit message, you can take care of both in one step:
there will be an [[|automatic comment]] added to
the Jira item with the commit id, and of course the Jira item id will be in the git commit
+ Additionally, if your commit is to the {{{cordova-js}}} repository, then you are encouraged
to add a prefix to the first line of your commit message that identifies which platform the
change is for, as multiple platforms use this repository. This helps make it clear which platform
authors should take interest in this commit. Here are 2 examples:
+ {{{
+ CB-2345 android: Improved exec bridge by using strings instead of JSON
+ CB-3456 all: Fixed plugin loading paths that start with /.
+ }}}
  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 [[|Git
  === Test Your Changes ===

View raw message