Page History

...

This document deals with issues that are important for MyFaces developers and custom component developers.

...

SVN guidelines

Code style

See http://www.apache.org/dev/styleguide.html^{Image Removed} for the Apache-Wide Coding Style Guide. Everything that is not documented there should be written according to Suns Java Code Conventions at http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html^{Image Removed}

Here is a formatter profile for eclipse 3.1: [codeconventions4eclipseapache-codeconv.xml] . Import it through Window->Preferences->Java->Code Style->Formatter

Here is a formatter profile for IntelliJ IDEA 7.0 (7718): [MyFacesIdeaSettings.jar] maven-idea-codestyle.xml. Import it through File->Import Settings ... This should add a new profile called "MyFaces"

...

• If there is no chance to get the system back to a stable state, a message with severity "fatal" should be logged and a ! RuntimeException (or derived class) should be thrown. Vice versa: Whenever a ! RuntimeException (or derived class) is thrown from within a catch clause, a message with severity "fatal" must have been logged right before.
• If the exception is severe, but there is a chance to continue processing, a message with severity "error" or "warning" should be logged.

...

Addition special comments (see 10.5.4 in ! CodeConv)

• TODO: something that is not yet ready
• HACK: something that is bogus but (meanwhile) necessary to make it work
• XXX: something that is bogus but works
• FIXME: something that is bogus and broken

...

Every file should start with the following copyright notice:

...

...

Class and Interface comment

Every class and interface should have a javadoc similar to this:

...

...

SVN Settings

Developers should be setting their autoprops so that files have an svn:eol-style of 'native'. Developers working on *nix systems are "lucky" because native on *nix is what SVN calls native, but the autoprops should still be set so that keywords are replaced as well. This is described on the [http://wiki.apache.org/struts/StrutsMaintenanceSvn]. Struts SVN wiki page.

Issue Tracker guidelines

Closing issues

...