[Engine-devel] Unifying (parts of) commit templates.

[Doron Fediuck]

----- Original Message -----
> From: "Michal Skrivanek" <michal.skrivanek at redhat.com>
> To: "Doron Fediuck" <dfediuck at redhat.com>
> Cc: engine-devel at ovirt.org
> Sent: Tuesday, August 14, 2012 4:25:01 PM
> Subject: Re: [Engine-devel] Unifying (parts of) commit templates.
> 
> 
> On Aug 12, 2012, at 13:56 , Doron Fediuck wrote:
> 
> > 
> > 
> > ----- Original Message -----
> >> From: "Allon Mureinik" <amureini at redhat.com>
> >> To: engine-devel at ovirt.org
> >> Sent: Sunday, August 12, 2012 11:17:19 AM
> >> Subject: Re: [Engine-devel] Unifying (parts of) commit templates.
> >> 
> >> 
> >> 
> >> ----- Original Message -----
> >>> From: "Livnat Peer" <lpeer at redhat.com>
> >>> To: "Itamar Heim" <iheim at redhat.com>
> >>> Cc: engine-devel at ovirt.org
> >>> Sent: Thursday, August 9, 2012 11:54:38 AM
> >>> Subject: Re: [Engine-devel] Unifying (parts of) commit templates.
> >>> 
> >>> On 09/08/12 11:52, Itamar Heim wrote:
> >>>> On 08/09/2012 09:11 AM, Livnat Peer wrote:
> >>>>> On 09/08/12 00:41, Doron Fediuck wrote:
> >>>>>> Hi All,
> >>>>>> It seems that for commit subjects, vdsm is using a general
> >>>>>> concept of-
> >>>>>> 
> >>>>>> BZ#??????? some message
> >>>>>> 
> >>>>>> I'd like to suggest adopting it to the engine template we use
> >>>>>> today-
> >>>>>> 
> >>>>>> BZ#??????? <core | restapi | tools | history | engine |
> >>>>>> userportal |
> >>>>>> webadmin>: short summary under 50 chars
> >>>>>> 
> >>>>>> This may help us write some scripts which will work both for
> >>>>>> vdsm
> >>>>>> and
> >>>>>> engine BZs.
> Is is a problem adopting the same for all the projects? It would be
> nice to be really consistent everywhere.
> 

We can't force (sub-)projects for a convention. We can only recommend.

> Is the <core|restapi… really useful for anything? Many times its not
> easy to say which is the right one, things are shared between
> webadmin and portal, etc...

It is. It helps us write a script to look for patches in specific areas.
If you have more than one relevant component, add:
936b5b09244b81e8a0d02bad3163f49da28771ba packaging, tools: Generate engine-config.xml from template

> In the past I found "BZ #123456 - bug title" on the first line to be
> the most helpful.

Some patches may apply to features or more than one bz, so additional flexibility is needed.
Also, one BZ may be fixed by several patches...

> 
> Also it would imho  be great if we get consistent tags for each build
> (or at least the commit ids) I know we are trying, but still its not
> really at the same time when the build is created.
> 
> Thanks,
> michal
> 
> >>>>>> 
> >>>>> 
> >>>>> +1
> >>>>> with a small change - adding a \n after the bz number -
> >>>> 
> >>>> wouldn't this kill git shortlog?
> >>>> patch short summary must be in first line iirc
> >>>> 
> >>> 
> >>> yes it will.
> >>> +1 for Doron's initial proposal
> >> +1.
> >> Also, while we're at it, a wiki explaining the correct way to use
> >> this template would be great.
> >> I know, it's pretty straight forward, but new contributed may get
> >> confused as to the distinction between core and engine, or how to
> >> mark a vertical patch that fixes a UI dialog and the backend logic
> >> behind it (with a coma between components? a slash? a pipe?)
> > 
> > Patch submitted:
> > http://gerrit.ovirt.org/#/c/7101/2
> > +2 is needed there.
> > 
> > Wiki may take time, so anyone who's willing to spare some time,
> > feel free to start with:
> > git commit -s -F config/engine-commit-template.txt -e
> > 
> > 
> >>> 
> >>>>> BZ#???????
> >>>>> <core | restapi | tools | history | engine | userportal |
> >>>>> webadmin>:
> >>>>> short summary under 50 chars
> >>>>> 
> >>>>> Long description of what this commit is about
> >>>>> 
> >>>>> Livnat
> >>>>> 
> >>>>>> Doron.