This document describes how to get started into developing SmartWeb itself. The SmartWeb Team have choosen the Eclipse IDE as the preferred development environment even if other IDE are supported too.
To set up the standard environment start downloading the latest Eclipse SDK release available for your platform then uncompress the package and start the IDE. Now install the plugins using the Eclipse Update Manager and the following informations:
With the environment setted up all you need to start your developer activity are the latest core and modules sources. To reduce the effort needed to introduce newbies we have decided to split each module on a separate project so if you wish to contribute to a single module all you need are those module sources!
To get the previous statement in practice you should create a new project checking it out from SVN using an anonymous connection to our repository and name the project accordingly (eg. smartweb-registry, smartweb-auth or simply smartweb to work on the core).
Once the project is downloaded the Eclipse IDE will automatically start to build the sources for you: if this is your first time on smartweb and/or Maven the process could be a few minutes long (depending on your internet connection speed) as Maven will need to download it's plugins and the project dependencies. During the download phase you can incur into a dependancy resolution error on two libraries:
Once you get those libraries on your hard drive you must install them into your Maven Repository with the following commands:
$ mvn install:install-file -DgroupId=javax.j2ee -DartifactId=j2ee -Dversion=1.4 -Dpackaging=jar -Dfile=/path/to/j2ee.jar/file $ mvn install:install-file -DgroupId=javax.transaction -DartifactId=jta -Dversion=1.0.1B -Dpackaging=jar -Dfile=/path/to/jta.jar/file
One last step is required if you wish to verify unit test code coverage as our choice is Clover which requires a license to be executed: copy the clover.license file from the smartweb root folder (the trunk folder in subversion) into your <home>/.m2 folder. Now everything should works fine and you can start developing with us!
First of all you need something to work on! Unless you have found a particular issue in the tracking system you would like to work on, the SmartWeb Team has categorized a few issues that we could use your help to solve them. Other things which needs your help can be found on the ToDos page and FixMe page which are usually updated frequently.
When you find a issue you would like to work on add a comment in the issue log so the core developers and other people looking for work know that someone is already working on it.
When you have either completed an issue or just want some feedback on the work you have done, create a patch and attach the patch to the issue in question. We have a couple of guidelines when creating patches:
An example on how to create a patch from the command line:
$ svn diff > smartweb-123.patch
If you are picking up an issue with a existing patch attached to the issue you can apply the patch to your working directory. If the patch is in a local file smartweb-auth-123.patch and you want to apply that use this command:
$ patch -p0 < smartweb-123.patch
A couple of notes:
If you've done a chunk of work and you would like ditch your changes and start from scratch use this command to revert to the original checkout:
$ svn revert -R .
The -R argument means that the command will recurse down all directories and revert all changes.
Before committing code to the Subversion repository we always set the svn:ignore property on the directory to prevent some files and directories to be checked in.
There are a number of criteria that a patch will be judged on:
Above all, don't be discouraged. These are the same requirements the current commiters should hold each other to as well. And remember, your contributions are always welcome! Related Projects
Commits should have a message that follows this template:
[issue1, issue2] <<comment>> Submitted by: (when it was a patch, put that persons name there)
issue can be omitted if there was no relevant issue, though it is strongly encouraged to create one for significant changes.
Submitted by only needs to be specified when a patch is being applied for a non-committer.
[smartweb-registry-1456] Added the foo to the bar Submitted by: Baz Bazman
Site generation requires some additional steps to be performed correctly. First of all you need Subversion command line tool installed onto your computer and available through command line which usually mean to have the svn binary executable into your environment PATH. As a second step you need to issue a request to the SourceForge subversion repository to accept permanently the SourceForge certificate: this step could be simply performed running
svn log https://smartweb.svn.sourceforge.net/svnroot/smartweb/trunk
Answer permanently upon certificate acceptance request.
Only project leaders or managers are allowed to release a new version to the public. The release process can be splitted into the following pratical steps: