Hi everyone,
we discussed on a process to improve potential regressions and especially their detection.
As a result, kindly follow these guidelines, it is part of a code review to check that:
1. Bug Report Quality
Please be aware that our bug reports are currently the only information for all adopters get an overview about applied changes. Please also remember, that BRs are public and there are quite a few people looking at them (internally and externally)
Therefore, titles should include indicated the area, effect and goal of a change.
It is part of the code review to check the BR title.
2. Mark potential regression BRs
If you believe that a fix or feature or any change could cause a regression in any other use case, add the keyword "regression" to the BR. This especially also includes any changes of behavior and in the visible UI, even if it is considered an improvement.
If in doubt, prefer to mark something as a potential regression.
In these cases, provide a comment like this:
REGRESSION INFORMATION
Summary of the critical part of the change
Potential regressions
Affected areas / use cases
Things that shall be tested
Again it is part of the code review to check the BR title.
3. Mark identified regressions after the fact
If you identify a regression, please add the "regression" keyword and the regression information after the fact.
Cheers
--
Eugen Neufeld, M.Sc.
Software Engineer / Consultant
EclipseSource Munich
Email: eneufeld@xxxxxxxxxxxxxxxxx
Web: http://eclipsesource.com/munich
Mobil: +49 176 22 85 11 50
Phone: +49 89 21 555 30 - 13
Fax: +49 89 21 555 30 - 19
EclipseSource Muenchen GmbH
Agnes-Pockels-Bogen 1
80992 Muenchen
General Managers: Dr. Jonas Helming, Dr. Maximilian Koegel
Registered Office: Agnes-Pockels-Bogen 1, 80992 Muenchen, Commercial Register Muenchen, HRB 191789
