Skip to: Site menu | Main content

Create a page called LeftHeader in Confluence for this content!

Get Involved Print

Quaere depends on you to contribute. Anyone can get involved by submitting patches to the code or anything else. If you discover a defect in Quaere, please let us know.

Quaere is a Codehaus project and therefore lives by the Codehaus manifesto. Please refer to this manifesto if your interested joining the project. The best way to become part of the project is to show your commitment by submitting patches, taking part in discussions on the mailing lists and so forth.

Getting in touch

The day to day discussions takes place on the developer mailing list. If you're interested in participating, we strongly suggest that you subscribe to this list. However, this is not a requirement, you can also submit patches through our issue tracking system.

You can also chat with developers from Quaere, and other Codehaus projects, in the codehaus room at irc.codehaus.org.

Getting started

To get started with Quaere development you can get the source code from our Subversion repository. Anonymous access is available through http://svn.codehaus.org/quaere/.

Checking out the Quaere trunk
$ svn checkout http://svn.codehaus.org/quaere/trunk/

Quaere is built with Maven. To build and test your fresh copy of the project you can use the following command;

Building and testing Quaere
$ mvn install

To jump start development you can use Maven to setup IDE.

IntelliJ IDEA
$ mvn idea:idea
Eclipse
$ mvn eclipse:eclipse

Creating and contributing a patch

A patch is a file shows the changes of one or more files. It is useful to us as we can see exactly what you changed, think about the implications and ultimately approve the patch so your changes are committed to the code repository.

We strongly encourage that you include test cases and documentation changes on your patch. If you need any help on how to test something, ask for help on the development mailing list.

Once you've made a change to one or more files in you working copy of Quaere you can create your patch using your favorite Subversion client. Below is an example of how to use the command line SVN client.

Creating a patch
$ svn diff > mypatch.diff
Large patches

If your patch targets many files in different directories, we prefer that you create your patch from the project root. This makes it easier for a committer to recognize where the patch should be applied.

Adding new files

If your modification includes new files or new folders you must add them before you create the patch. If you're using the command line client you can do this with the svn add <filename> command.

To contribute your patch to the project, we prefer if you write a comment on the JIRA issue the patch is for in our issue tracker and attach your patch to this comment. Alternatively, you can attach the patch to an email on our developer mailing list.