Page History

...

1. The project must keep backward compatibility between minor versions, unless the change is required to fix a bug.
2. The project should keep backward compatibility between major versions, if possible.
3. In order to reduce amount of potential backward compatibility problems, follow the following guidelines:
   1. Expose as few APIs as possible to user.
   2. Prefer exposing interfaces , to exposing classes.
   3. An internal class, must have the internal word in its package name (e.g. org.apache.wink.internal)
   4. Remember: it's always possible to move a class from internal package outside, but it's never possible to move the classes to internal, after they were released.
   5. Classes that are exposed to user only by their class name (e.g. servlets, listeners, spring beans) should be located in the internal package. However, they must contain a javadoc clarification that their name must not be changed.

...

1. All Spring bean names must start with "wink".
2. Do not use dots in the bean names, since it may effect some spring functionality (e.g. util:property-path cannot be used with dots)
3. Add "internal" to the bean names that should not be used by the user.
4. When using PropertyPlaceholderConfigurer use the following guidelines:
   1. The order property should be set between 1 and Integer.MAX_VALUE. I would suggest setting it somewhere around Integer.MAX_VALUE/2 to ensure that anyone can insert a PropertyPlaceholderConfigurer both before and after yours.
   2. Set ignoreUnresolvablePlaceholders to true, to ensure that Wink won't fail because of others placeholders.
   3. Create a unit test, which will hold a validating PropertyPlaceholderConfigurer (ignoreUnresolvablePlaceholders=false) to ensure that none forgets to resolve a placeholder.
   4. All properties must start with "wink".

Building

Note: It's not yet decided if Ant or Maven or both will be used for building.

...