1. Need proper documentation for creating and configuring dashboard.xml
2. Structure of dashboard.xml should be easily understandable/readable
- Using JSON format for dashboard.xml would not be appropriate, a
proper xml structure should be there
- Anyway, using JSON for gadgets and xml for the layout might be
appropriate
3. Get rid of common bundle
4. Need to check whether debug is enabled before logging
5. Exceptions should be properly handled
- Should be able to quickly identify any error with stacktrace and
logs
- Logging message should be added to the exception
- Exceptions shouldn't be swallowed, if not in any case, should be
properly commented the reason
- Throwing AxisFault with an error code/message and handing it
accordingly
6. Need to think about distributed nature
- Availability of resources should be checked properly before using
them.
- i.e. we should check whether the registry is available and failure
conditions should be handled
7. Add a mothod into carbon utils to get backend http port
8. Proper coding to avoid unnessasary memory usage.
- e.g. defining error message separatly and passing it into the debug()
method
9. Using readable variable names
- e.g. boolean variable names should start with is, "isNewUser"
10. Using primitive data types where possible as object initiation wastes
more resources
11. Remove unnecessary paranthesis
12. Extract repetitive codes and use methods instead
- both in Java and Javascript
13. Remove redundant varialbes
14. Comments should be added
- At Java class declaration(describing the class)
- In Javascripts codes
15. Proper coding convension should be followed across the plaltform
for Javascripts
16. Get rid of using CDATA in gadgets as it is difficult to validate the
JS code
- Separate JS code into files and use references to those files
instead
*Proposed Features*
- User specific gadget repo (i.e. giving users a registry space to store
gadgets) and gadget sharing
_______________________________________________
Carbon-dev mailing list
[email protected]
https://mail.wso2.org/cgi-bin/mailman/listinfo/carbon-dev
