Menu

General

• Home
• News
• Screenshots
• Downloads

Documentation

• Documentation
• Wiki

Project

• Development site
• Release Schedule
• Project Team
• Contributing
• Issuetracking
• VQWiki 3.x mind map

Other

• Links

---

Contributing to the VQWiki project

Helping out in general

So you want to help? Good!
You can offcourse help by becoming a team member and do some programming, testing, translating or one of the other tasks that need doing... but we also need other things. To give you an idea of what we need as a project and how you can help, here's a short list:

• Become an project team member. (see below)
• Create and submit plugins for this project. (see below)
• Submit patches to the project. (see below)
• Donate advertising space or spread the word about VQWiki
• Donate so we can pay for webhosting, events, etc.
• Your love and support ;-)

If you'd like to donate or otherwise help us, you van use the donate icon at the bottom of the page or you can contact us.

---

Helping out; becoming a team member

So you'd like to become a VQWiki project team member? That's wonderfull!
Remember: it doesn't matter whether or not you are a programmer, just like any other project we need non-programmers as well. So, what kind of people are we looking for? Glad you asked...

• Java Developers
• Testing team members
• Translation team members (please see the Project Team page for vacant positions)
• Documentation team members
• Graphical designers / User Interface designers
• Non-tech support team members

Please read the requirements section below on the few requirements that you do need to abide by.

SourceForge Account

Unless you are a developer on the team, a SourceForge.net account is strictly speaking not necessary though we do recommend it. To become an active member of our development team, a valid SourceForge.net account is mandatory. Otherwise, we will not be able to give you write access to the Subversion code repository.

If you haven't already got a SourceForge.net account, get one at http://sourceforge.net, and mail us your username. We can then set up Subversion repository permissions so you can have full access to commit back to the code repository system, assuming offcourse you are in a programmer role.

To check out the code from the Subversion repository, please use the following command:

To be able to commit changes back into the repository, you will have to authenticate using your Sourceforge.net username en password. This will only succeed if you have been granted commit access rights by the project administrator. All in all, you need the information listed below to configure your Subversion client of choice for commit access. The following configuration settings are used to access a SourceForge.net-hosted SVN repository:

• Hostname: svn.sourceforge.net
• Port: 443
• Protocol: HTTPS
• Repository Path: /svnroot/veryquickwiki/trunk/vqwiki-classic
• Username: Your SourceForge.net username.
• Password: Your SourceForge.net user password.

---

Helping out; contributing plugins

Rather than altering the main code base, many pieces of added functionality can be implemented by creating lexer or action plugins. Check out the plugin source code and download the plugins from the download page to see how easy it is to implement them. If you want to implement something that the plugin API doesn't seem to support, let us know and we'll see if we can add support to the API for them.

---

Helping out; submitting patches

You can further help the project to improve the VQWiki software by submitting patches. Before creating a patch, please verify that the issue was not already solved in the most recent version of the software. To begin building a patch, download the code from the Subversion code repository at Sourceforge (see "Anonymous Subversion Access") and update the source code where necessary. You can then generate the patch and submit it via our issuetracking system or mail the patches to us and we'll merge them into the main code stream.

Generating a patch

To create a patch, check out the sourcecode from the Subversion code repository and alter the file. Then, to generate the patch, just run this command:

---

Anonymous Subversion Access

You don't need a SourceForge account or permissions to use the anonymous Subversion repository access. You can check out a copy of the code and then generate patch files that reflect the changes you've made. The command you need to know to check out a copy from the Subversion repository is:

Requirements

Your contributions need to be:

• JDK 1.4 compliant
• JavaServlets 2.3 compliant, i.e. no extensions beyond the 2.3 spec
• Tested with Tomcat 4.1, this is the recommended container for VQWiki