Dashboard > WADI > Developers > Conventions
Conventions Log In | Sign Up   View a printable version of the current page.

Added by jules , last edited by jules on Apr 27, 2006  (view change)
Labels: 
(None)

Code Style

I don't like to tell people what their code should look like, but a consistant approach benefits everyone as well as the perception of our project.

Here are some conventions in decreasing order of importance, that I would like to see adhered to :

  • IOC with Constructor arg injection
  • Poolable types have a void ctor, a 'public void init(...)' and a 'public void clear()'
  • lazy initialisation implemented via e.g. Foo.init(FooConfig config) - where FooConfig is an interface
  • Eclipse code style file may be found here (Project->Properties->Java Code Style/Formatter->Enable Project Specific Settings->Import...)
  • "When in Rome, do as the Romans" - i.e. whatever you like in your own code, but follow other people's conventions in their code.
  • imports fully expanded
  • 'boolean getX()' rather than 'boolean isX()'

Continuous Integration - Beetlejuice.

WADI is built and tested after every SVN commit by Beetlejuice. If you break the build, a mail will be sent to wadi-dev, notifying all developers that it is broken. If you wish to save yourself this embarassment, you should try running the bin/beetlejuice.shscript before committing. Note that just because something builds in your favourite IDE, does not necessarily mean that it will not break the Beetljuice build, which builds and tests all code as well as the website and other development tools using Maven2.

Issue Management - JIRA

WADI issues are managed in JIRA. Please keep JIRA up to date with all issues that you discover or with which you are dealing. If you fix an issue, please include the JIRA link within the SVN commit message and the SVN version within the JIRA resolution comment.

Site running on a free Atlassian Confluence Open Source Project License granted to The Codehaus. Evaluate Confluence today.
Powered by Atlassian Confluence, the Enterprise Wiki. (Version: 2.6.2 Build:#919 Nov 26, 2007) - Bug/feature request - Contact Administrators