Re: [Starlingx-discuss] Please Review: Requirements for commit messages

13 Sep 2019


      ... but the Story itself relates all the updates regardless of the wording content and I see value in that.
...
-----Original Message-----
From: Cordoba Malibran, Erich [mailto:erich.cordoba.malibran@intel.com]
Sent: Friday, September 13, 2019 3:27 PM
To: MacDonald, Eric; Saul Wold; starlingx-discuss@lists.starlingx.io
Subject: Re: [Starlingx-discuss] Please Review: Requirements for commit messages
Importance: High
On 9/13/19, 1:31 PM, "MacDonald, Eric" <Eric.MacDonald@windriver.com> wrote:
There are stories created for other similar cleanup or like activities; why not for changes in support of
opensuse (this example)?
https://storyboard.openstack.org/#!/story/2006508 - Move specfiles from OBS to Gerri
    https://storyboard.openstack.org/#!/story/2006425 - Code cleanup in fault component
As a contributor now I know that if I don't create these stories, a reviewer will complain about not
having it even if the commit message is enough clear. I you open the stories you'll see that doesn't
add any value more than the provided commit message. I create those above, but I've seen
others with the same format.
The Goodhart's law[0] states that "When a measure becomes a target, it ceases  to be a good
measure.". If our goal is to have stories and bugs in all contributions we'll end having meaningless
stories/bugs.
[0] https://en.wikipedia.org/wiki/Goodhart%27s_law
Inconsistency breads complacency ...
Eric.
> -----Original Message-----
    > From: Saul Wold [mailto:sgw@linux.intel.com]
    > Sent: Friday, September 13, 2019 2:08 PM
    > To: starlingx-discuss@lists.starlingx.io
    > Subject: Re: [Starlingx-discuss] Please Review: Requirements for commit messages
    >
    >
    >
    > On 9/13/19 10:27 AM, MacDonald, Eric wrote:
    > > There seem to be a lot of small changes that are being posted without quality or traceable
reasoning
    > and I feel that creating a SB and tasks for like changes helps reviewers and project/content
managers.
    > >
    > The group of recent changes have been talked about before as part of the
    > over all improvements in order to address various aspects of working
    > with openSUSE and warning that are generated from that build.
    >
    > These are mostly small changes as you point out and are understandable.
    >
    > Sau!
    >
    > >> -----Original Message-----
    > >> From: Jones, Bruce E [mailto:bruce.e.jones@intel.com]
    > >> Sent: Friday, September 13, 2019 12:54 PM
    > >> To: Eslimi, Dariush; MacDonald, Eric; Khalil, Ghada; Saul Wold; starlingx-discuss@lists.starlingx.io
    > >> Subject: RE: [Starlingx-discuss] Please Review: Requirements for commit messages
    > >> Importance: High
    > >>
    > >> It's just an example, Dariush, of an internal change that would not impact an end user.  Insert
your
    > own
    > >> example if needed. :)
    > >>
    > >> Commit messages can provide plenty of context.  If they are written well, of course, which the
    > reviewers
    > >> can verify / enforce.
    > >>
    > >> I'm not opposed to using SB and LP to document changes.  But I don't think it's necessary to
mandate
    > it
    > >> for every single change.
    > >>
    > >>       brucej
    > >>
    > >>
    > >> -----Original Message-----
    > >> From: Eslimi, Dariush [mailto:Dariush.Eslimi@windriver.com]
    > >> Sent: Friday, September 13, 2019 8:53 AM
    > >> To: Jones, Bruce E <bruce.e.jones@intel.com>; MacDonald, Eric
<Eric.MacDonald@windriver.com>;
    > >> Khalil, Ghada <Ghada.Khalil@windriver.com>; Saul Wold <sgw@linux.intel.com>; starlingx-
    > >> discuss@lists.starlingx.io
    > >> Subject: RE: [Starlingx-discuss] Please Review: Requirements for commit messages
    > >>
    > >> I would argue that is very bad example, why would a single project all of sudden wants to switch
to
    > >> Python3?
    > >> Is this part of release goal to start using Python 3? Is this priority for the release?
    > >>
    > >> Small change need more context so code reviewers know why such a change is proposed.
    > >>
    > >> Dariush
    > >>
    > >> -----Original Message-----
    > >> From: Jones, Bruce E [mailto:bruce.e.jones@intel.com]
    > >> Sent: September-13-19 11:37 AM
    > >> To: MacDonald, Eric <Eric.MacDonald@windriver.com>; Khalil, Ghada
    > <Ghada.Khalil@windriver.com>;
    > >> Saul Wold <sgw@linux.intel.com>; starlingx-discuss@lists.starlingx.io
    > >> Subject: Re: [Starlingx-discuss] Please Review: Requirements for commit messages
    > >>
    > >> -1.  Commit messages are update reasons and just as traceable.
    > >>
    > >> Do we really need a SB entry for changes like "replace #!/usr/bin/python with
#!/usr/bin/python3"?
    > >>
    > >>           bruej
    > >>
    > >> -----Original Message-----
    > >> From: MacDonald, Eric [mailto:Eric.MacDonald@windriver.com]
    > >> Sent: Friday, September 13, 2019 8:30 AM
    > >> To: Khalil, Ghada <Ghada.Khalil@windriver.com>; Saul Wold <sgw@linux.intel.com>; starlingx-
    > >> discuss@lists.starlingx.io
    > >> Subject: Re: [Starlingx-discuss] Please Review: Requirements for commit messages
    > >>
    > >> +2 Ghada's point. I'd like to avoid the slippery slope no update reason or traceability can lead to.
    > >>
    > >>> -----Original Message-----
    > >>> From: Khalil, Ghada [mailto:Ghada.Khalil@windriver.com]
    > >>> Sent: Friday, September 13, 2019 11:11 AM
    > >>> To: Saul Wold; starlingx-discuss@lists.starlingx.io
    > >>> Subject: Re: [Starlingx-discuss] Please Review: Requirements for
    > >>> commit messages
    > >>>
    > >>> Hi Saul,
    > >>> This was discussed previously and, as a community, we agreed that this
    > >>> is the guideline for starlingx submissions
    > >>>
    > >>> From
    > >>> https://wiki.openstack.org/wiki/StarlingX/CodeSubmissionGuidelines
    > >>> Link your review to a StoryBoard Story or Launchpad Bug For
    > >>> traceability, always link your code change to a story or bug. The
    > >>> story/bug will give reviewers context for the code changes. This will
    > >>> also be used to help determine the relative priority of the code changes.
    > >>>
    > >>>
    > >>> I personally don't see a big barrier to creating a generic storyboard
    > >>> for spelling or cleanup tasks. Happy to hear from others their opinion.
    > >>> I'm not terribly concerned about a few small updates without a link,
    > >>> but we should all aim to favor traceability (and document the purpose for the changes we're
    > making).
    > >>>
    > >>> Regards,
    > >>> Ghada
    > >>>
    > >>> -----Original Message-----
    > >>> From: Saul Wold [mailto:sgw@linux.intel.com]
    > >>> Sent: Thursday, September 12, 2019 5:53 PM
    > >>> To: starlingx-discuss@lists.starlingx.io
    > >>> Subject: [Starlingx-discuss] Please Review: Requirements for commit
    > >>> messages
    > >>>
    > >>>
    > >>> StarlingX Folks:
    > >>>
    > >>> I would like to clarify the requirement or lack there of for having Bugs or Stories in commit
    > messages.
    > >>> There are patches that are clearly addressing bug fixes and those
    > >>> should have a Closes-Bug; there are commits that are clearly implementing features that should
    > have
    > >> the Story/Task tags.
    > >>>
    > >>> There are also commits that fall in between, they are not directly
    > >>> related to a given feature or have a bug filed, they are typically
    > >>> smaller and are fairly self-documenting or have good commit messages explaining why the
change
    > is
    > >> needed, not just what the change does.
    > >>>
    > >>> Ultimately Closes-Bugs and Story tags will help reviewers and other
    > >>> get the infomration needed to create release notes, but we don't need
    > >>> to document every change like spelling, indentation, fixing compiler warnings in Release notes.
    > >>>
    > >>> I believe that we should have some flexibility in allowing for changes
    > >>> without related launchpad or story connections. This can help reduce
    > >>> the barrier to entry for small changes that community members may want to propose.
    > >>>
    > >>> Thoughts?
    > >>>
    > >>> Sau!
    > >>>
    > >>> _______________________________________________
    > >>> Starlingx-discuss mailing list
    > >>> Starlingx-discuss@lists.starlingx.io
    > >>> http://lists.starlingx.io/cgi-bin/mailman/listinfo/starlingx-discuss
    > >>> _______________________________________________
    > >>> Starlingx-discuss mailing list
    > >>> Starlingx-discuss@lists.starlingx.io
    > >>> http://lists.starlingx.io/cgi-bin/mailman/listinfo/starlingx-discuss
    > >> _______________________________________________
    > >> Starlingx-discuss mailing list
    > >> Starlingx-discuss@lists.starlingx.io
    > >> http://lists.starlingx.io/cgi-bin/mailman/listinfo/starlingx-discuss
    > >> _______________________________________________
    > >> Starlingx-discuss mailing list
    > >> Starlingx-discuss@lists.starlingx.io
    > >> http://lists.starlingx.io/cgi-bin/mailman/listinfo/starlingx-discuss
    > > _______________________________________________
    > > Starlingx-discuss mailing list
    > > Starlingx-discuss@lists.starlingx.io
    > > http://lists.starlingx.io/cgi-bin/mailman/listinfo/starlingx-discuss
    > >
    >
    > _______________________________________________
    > Starlingx-discuss mailing list
    > Starlingx-discuss@lists.starlingx.io
    > http://lists.starlingx.io/cgi-bin/mailman/listinfo/starlingx-discuss
    _______________________________________________
    Starlingx-discuss mailing list
    Starlingx-discuss@lists.starlingx.io
    http://lists.starlingx.io/cgi-bin/mailman/listinfo/starlingx-discuss