Currently, bug descriptions follow several different styles.
|
Style
|
Example(s)
|
Description of bug
|
TLS Gateway uses weak ciphers
InvalidClassException when using adaptive ERT
|
|
"A problem has been solved…"
+
Description of bug
|
A problem has been solved where Unix Agent stops working after loosing connection to Automation Engine.
A problem has been solved where job execution takes longer that expected due to Job Messenger connection problem to Agent.
|
|
"A bug was fixed…"
+
Description of bug
|
A bug was fixed where resolving variables that used VARA objects would filter on the column they were supposed to return instead of the variable key.
A bug was fixed on AIX where ERT numbers were converted twice to big endian yielding false estimations of runtime times.
|
| Vague placeholder description |
Security related update included. |
It would be helpful if Broadcom would adopt a consistent style for bug titles, summaries & descriptions. I suggest adopting the standard of naming and describing bugs in a straightforward way, without superfluous & repetitious boilerplate text.
For example, I suggest removing the boilerplate text "A problem has been solved where" from the following bug title:
Old: "A problem has been solved where Unix Agent stops working after loosing connection to Automation Engine"
New: "Unix Agent stops working after loosing connection to Automation Engine".
For the security bugs, I understand that Broadcom is provides vague titles on purpose. Here too though, I would suggest describing the problem, not the fix or the fact that a fix is included"
Old: "Security related update included."
New: "Security-related bug".
By adopting these changes, and ensuring that bugs are named in a consistent way and extraneous information is omitted, Broadcom can improve the readability of release notes.