|View Issue Details|
|Type||Category||Severity||Reproducibility||Date Submitted||Last Update|
|feature request||[Openbravo ERP] A. Platform||minor||always||2008-04-15 16:48||2008-06-27 15:47|
|Priority||normal||Resolution||duplicate||Fixed in Version|
|Status||closed||Fix in branch||Fixed in SCM revision|
|OS Version||Database version||Ant version|
|Product Version||SCM revision|
|Review Assigned To|
|Regression introduced in release|
|Regression introduced by commit|
|Triggers an Emergency Pack||No|
0003487: add header to WAD generated files to help reading the code
Here is something very simple you could do to help third party developpers understand and participate to Openbravo code.
Indeed, since you favored code generation over interpreted code (why?), there are currently lots of files, configuration and processes to generate the correct files. This makes it hard for the newbie to get the whole process and get involved into OB developpment.
So may be you can simply add some explicit header to WAD generated files, like "this file has been generated by ANT task xx after source file yy, do not edit it directly but edit yy instead".
Lot's of oss code generation projects do that actually.
Why would that help? Suppose I know standard J2EE developpement but not the particular OB plateform (usual case) and I see something going wrong with an OB server: from my general knowledge I manage to enter the involved servlet but then I get stuck because I see code generated Java files and HTML files. Instead I could simply read the header and know where I can tune OB code exactly to meet my own needs.
I know that it's currently explicitly stated which directories involve generated code. But I just think it's less obvious and you have to read the whole dev documentation to know that.
What do you think?
|Tags||No tags attached.|
edited on: 2008-06-12 09:44
This bug was originally reported in SourceForge bug tracker and then migrated to Mantis.
You can see the original bug report in:
|2008-06-27 15:47||pjuvara||Relationship added||duplicate of 0003304|
|2008-06-27 15:47||pjuvara||Status||new => closed|
|2008-06-27 15:47||pjuvara||Duplicate ID||0 => 3304|
|2008-06-27 15:47||pjuvara||Resolution||open => duplicate|
|Copyright © 2000 - 2009 MantisBT Group|