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

Saul Wold sgw at linux.intel.com
Thu Sep 12 21:53:06 UTC 2019


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!



More information about the Starlingx-discuss mailing list