[Starlingx-discuss] Test Plan required in commit messages (was RE: Introducing Test Plan Section in Commit Message)

Miller, Frank Frank.Miller at windriver.com
Fri Dec 17 16:13:02 UTC 2021

StarlingX Community:

Please remember to include a test section in your commit messages as per the guidelines and Ram's email from October. Thanks.


From: Subramanian, Ramaswamy <Ramaswamy.Subramanian at windriver.com>
Sent: Wednesday, October 6, 2021 8:53 AM
To: starlingx-discuss at lists.starlingx.io
Subject: [Starlingx-discuss] Introducing Test Plan Section in Commit Message


We have received numerous feedback from various team members to improve the following items.

  1.  Core reviewer(s) of various repositories have very limited visibility on the tests (scenarios, count, etc) executed on the code posted for review.  There is additional communication between core reviewer(s) and author to understand tests executed.  In some cases, core reviewer(s) request additional test coverage.
  2.  Share the developer test details between development and test teams in a consistent way.

In order to address the above items, we are introducing a test plan section in the commit message.  This section should specify tests executed on the changed code.  Please refer to the updated code submission guide<https://urldefense.com/v3/__https:/docs.starlingx.io/developer_resources/code-submission-guide.html__;!!AjveYdw8EvQ!I0vh8VZn0cHGHK_6Ys7ixmC4RSxq7a8bQF_p_7bbQxaO88AfT6SsumxQq6ZBIO6FXi52$> for additional details.  An example commit message is added to the wiki<https://urldefense.com/v3/__https:/wiki.openstack.org/wiki/GitCommitMessages__;!!AjveYdw8EvQ!I0vh8VZn0cHGHK_6Ys7ixmC4RSxq7a8bQF_p_7bbQxaO88AfT6SsumxQq6ZBINoh4cyZ$>.

We encourage everyone to adopt the updated commit message template effective immediately.

Should you have any suggestions/feedback to improve this further, please do not hesitate to reach out.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.starlingx.io/pipermail/starlingx-discuss/attachments/20211217/6a6d968d/attachment.htm>

More information about the Starlingx-discuss mailing list