commit templates for deegree SVN
Contents |
For a description on how to integrate these templates in Eclipse, please refer to the respective page.
1. deegree2 templates
topic: bug fix type: $select -> critical, major, normal, minor$ module: $select -> enterprise, model, [Service Name], commons, portal std., portal portlet, tools, security, framework, iGeoDesktop, other$ description: $add description$ topic: api changed type: $select, multiple choices possible -> method signature, method visibility, class visibility, inheritance, constants added, constants renamed, constants removed, method added, method renamed, method removed, class renamed, class moved to another package, $ module: $select -> enterprise, model, [Service Name], commons, portal std., portal portlet, tools, security, framework, iGeoDesktop, other$ description: $add description$ topic: class added module: $select -> enterprise, model, [Service Name], commons, portal std., portal portlet, tools, security, framework, iGeoDesktop, other$ description: $add description$ topic: class removed module: $select -> enterprise, model, [Service Name], commons, portal std., portal portlet, tools, security, framework, iGeoDesktop, other$ description: $add description$ topic: code enhanced type: $select; multiple choices possible -> performance, scalability, stability, flexibility, configurability, functionality, other$ module: $select -> enterprise, model, [Service Name], commons, portal std., portal portlet, tools, security, framework, iGeoDesktop, other$ description: $add description$ topic: comment added/corrected description: $add description$ topic: code formatting description: $add description$ topic: other resources type: $select -> XML, XSD, XSL, properties, library, sql script, batch script, shell script, ANT script, image, documentation, specification, data$ module: $select -> enterprise, model, [Service Name], commons, portal std., portal portlet, tools, security, framework, iGeoDesktop, other$ description: $add description$ topic: web pages type: $select; multiple choices possible -> JSP, JS, HTML, CSS, XML, XSL$ module: $select -> portal std., portal portlet, drm-admin, owsWatch, other$ description: $add description$
2. deegree3 templates
After working with the deegree 2 templates for some time now, several issues have been identified (especially when trying to apply the templates to deegree 3):
- Very often, there is no (single) matching template, e.g. one commit can very well fall into all categories "code enhanced", "class added" and "class removed".
- The differentiation does not seem to have a positive effect on generating release notes automatically, it actually makes writing an automated process very complex.
- The term "module" is not precisely defined -- especially for deegree 3. Should this apply to SVN modules, services/subsystems or some other kind of logical component structure/naming? The result of is that there is no simple rule for deriving the correct input for this field. This leads to unpredictable results and generally costs a lot of time for deducing the right answer.
Therefore, no commit templates are used in deegree 3. Simply write a reasonable description of what your change does and include a reference to the tracker issue if applicable.
In the future, a tracker/issue-oriented development mode (including proper Mylyn integration in Eclipse) should be reconsidered to provide integrated commit messages.