On Fri, Apr 6, 2018 at 12:16 AM, Thanh Ha <[email protected]> wrote:
> On Thu, Apr 5, 2018 at 12:32 PM, Sam Hague <[email protected]> wrote: > >> What would the workflow be with the new jira and gerrit integration? And >> what best-practices should be used when creating commit messages? >> >> Typically users have included the bug-id in the beginning of the summary >> line. That eats up some of the 50 characters allowed so it isn't good. >> Should we encourage something more like what openstack is doing in [1] >> where they suggest adding lines in the message themselves like "Closes-Bug: >> #####", "Partial-Bug: #####"? This seems better and gives more space to the >> commit-message summary line. >> >> Thanks, Sam >> >> [1] https://docs.openstack.org/infra/manual/developers.html#deve >> lopment-workflow >> >> > I've always recommend folks treat the footer block in a commit message as > metadata. Things like bug IDs should go there so it will look like: > > Summary line > > Message body > continued body lines... > > NETVIRT-1234 > Change-Id: .... > Signed-off-by: .... > > > You can add words in front of the Jira ID too like "closes:" "Issue:", > "fixes", etc... I'm not sure if the Jira integration supports any specific > words but I know it picks up at least he Jira ID. > I like the "Issue: NETVIRT-1234" syntax (finding an upper case "-ID" ugly, and "Issue-Id" superfluous)... I'll start using that in footers in future work. Regards, > Thanh > >
_______________________________________________ Discuss mailing list [email protected] https://lists.opendaylight.org/mailman/listinfo/discuss
