Commit comment format enforcer

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Commit comment format enforcer

waltw87
Hi,

Since the standard for Git comments is to have a one-line summary / label, followed by a blank space, followed by a more in depth description of the changes, why not separate SmartGit's Commit Message prompt into two text boxes - one labeled "Title" and the other labeled "Description"?  Then SmartGit would automatically apply the title line, blank space, description formatting, and it would be more apparent how the message will appear in logs.  Disallowing the title to be blank but allowing the description to be blank would still provide for short comments as well.

Thanks,
-Walt

Reply | Threaded
Open this post in threaded view
|

Re: Commit comment format enforcer

syntevo Support
Hi Walter,

Frankly, I like your suggestion, but it could make it a lot harder for us to
add a spell-checker, because we only have one for multi-line text fields.

--
Best regards,
Thomas Singer
=============
syntevo GmbH
http://www.syntevo.com
http://blog.syntevo.com


"waltw87" <[hidden email]> wrote:

> Hi,
>
> Since the standard for Git comments is to have a one-line summary / label,
> followed by a blank space, followed by a more in depth description of the
> changes, why not separate SmartGit's Commit Message prompt into two text boxes
> - one labeled "Title" and the other labeled "Description"?  Then SmartGit
> would automatically apply the title line, blank space, description formatting,
> and it would be more apparent how the message will appear in logs.
> Disallowing the title to be blank but allowing the description to be blank
> would still provide for short comments as well.
>
> Thanks,
> -Walt
>
>






Reply | Threaded
Open this post in threaded view
|

Re: Commit comment format enforcer

waltw87
No way to trick the spell-checker into thinking the title bar is multi-line?

It also might be worth considering that the title box could auto-expand, in the case of an extra-long (but still single) line-item.  Perhaps place a 128 max character limit on it to prevent it from growing out of hand, and display a "Title Characters Left" indicator that many short-post forums present users with today.

-Walt

--- In [hidden email], syntevo Support <smartgit@...> wrote:

>
> Hi Walter,
>
> Frankly, I like your suggestion, but it could make it a lot harder for us to
> add a spell-checker, because we only have one for multi-line text fields.
>
> --
> Best regards,
> Thomas Singer
> =============
> syntevo GmbH
> http://www.syntevo.com
> http://blog.syntevo.com
>
>
> "waltw87" <waltw87@...> wrote:
>
> > Hi,
> >
> > Since the standard for Git comments is to have a one-line summary / label,
> > followed by a blank space, followed by a more in depth description of the
> > changes, why not separate SmartGit's Commit Message prompt into two text boxes
> > - one labeled "Title" and the other labeled "Description"?  Then SmartGit
> > would automatically apply the title line, blank space, description formatting,
> > and it would be more apparent how the message will appear in logs.
> > Disallowing the title to be blank but allowing the description to be blank
> > would still provide for short comments as well.
> >
> > Thanks,
> > -Walt
> >
> >
>