I've noticed that there seems to be no convention for the note within a commit message, about wich Github issue it addresses. Often it looks like "This is an awesome commit. Fixes #X." as first commit line, wich should be limited to 50 chars. Thus the phrase "Fixes #X." wastes a lot of the documentation space. I know it's fussy, but i'll wonder if something like "X This is an awesome commit." is fine?
Greets, Martin
Hello,
I prefer to put the "Fixes #num." in the "body" of the commit message like
This is the most awesome feature
Beware of its uniqueness. Fixes #42
The information about the related issue is not that important when using Git --online commands. Also you may refer to issues in commits but not close them
This feature is related to #42 and sweeps out of the way half the problem.
Greets
Furthermore i would ask if it would be useful, if any commit is dedicated to an issue, even if it wont complete it. Assume i would open issue '#123 A new feature is needed' and subsequently create 3 commits like '123 First commit', '123 Second commit' and '123 final commit'. Wouldn't this be more manageable?
Martin
On 01/17/2012 12:27 PM, Martin Stein wrote:
I've noticed that there seems to be no convention for the note within a commit message, about wich Github issue it addresses. Often it looks like "This is an awesome commit. Fixes #X." as first commit line, wich should be limited to 50 chars. Thus the phrase "Fixes #X." wastes a lot of the documentation space. I know it's fussy, but i'll wonder if something like "X This is an awesome commit." is fine?
Greets, Martin
Keep Your Developer Skills Current with LearnDevNow! The most comprehensive online learning library for Microsoft developers is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3, Metro Style Apps, more. Free future releases when you subscribe now! http://p.sf.net/sfu/learndevnow-d2d _______________________________________________ Genode-main mailing list Genode-main@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/genode-main
While we're on it, how importend is it to describe the circumstances a commit addresses? I.e. assume i wrote a commit that fixes a bug on the PBXA9 board only within 'base-hw'. The first line of the commit would be "Fix a nightmarish bug, in 'base-hw' on the ARM PBXA9 board.", but this is often to longer then 50 chars :-)
Martin
On 01/17/2012 12:37 PM, Martin Stein wrote:
Furthermore i would ask if it would be useful, if any commit is dedicated to an issue, even if it wont complete it. Assume i would open issue '#123 A new feature is needed' and subsequently create 3 commits like '123 First commit', '123 Second commit' and '123 final commit'. Wouldn't this be more manageable?
Martin
On 01/17/2012 12:27 PM, Martin Stein wrote:
I've noticed that there seems to be no convention for the note within a commit message, about wich Github issue it addresses. Often it looks like "This is an awesome commit. Fixes #X." as first commit line, wich should be limited to 50 chars. Thus the phrase "Fixes #X." wastes a lot of the documentation space. I know it's fussy, but i'll wonder if something like "X This is an awesome commit." is fine?
Greets, Martin
Keep Your Developer Skills Current with LearnDevNow! The most comprehensive online learning library for Microsoft developers is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3, Metro Style Apps, more. Free future releases when you subscribe now! http://p.sf.net/sfu/learndevnow-d2d _______________________________________________ Genode-main mailing list Genode-main@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/genode-main
Keep Your Developer Skills Current with LearnDevNow! The most comprehensive online learning library for Microsoft developers is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3, Metro Style Apps, more. Free future releases when you subscribe now! http://p.sf.net/sfu/learndevnow-d2d _______________________________________________ Genode-main mailing list Genode-main@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/genode-main
-
Christian Helmuth -
Martin Stein