Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
SWT/Devel/commitmessage
About
The goal of a commit message is to clear out ambiguities for the reviewer(s) and any developer who may read the message later. I.e, it should be comprehensive and avoid skipping information that was passed verbally or via chat.
Structure
An SWT git commit message should ideally look as following:
Bug ID : Bug description # The bug description should be the same as that in Bugzilla. Maybe slightly trimmed.
Description of patch/fix
Test strategy *1
jUnit Tests performed *2
Change-id: xxxxxxxxxxx
Signed-off-by: First Last <email@address.com>
Test Strategy *1
Steps outlining how to reproduce the issue. E.g link to a snippet, or steps to follow, or pointer to where to find such instructions.
jUnit Tests performed *2
You should mention if you ran the relevant SWT jUnit tests. For example "Ran allNonBrowserTests on Wayland" and related results.
If they don't need to be ran, unless the patch is trivial, mention why there is no need to run the tests.