Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

1.6. Contributing

1.6.1. Registering at SF

Interested in contributing to the VCF project ? Great ! First you need to become a member of Source Forge. SourceForge membership is free, and only takes a minute to fill out the web form. It is a requirement for participating in any Source Forge sponsored project, like the VCF. You can join at the Source Forge New User page.

Next, you need to email me, and let me know to add you to the project. It usually takes a day or so for your Source Forge account to become activated, so keep that in mind. If your a developer, you'll be added with read/write privileges to the CVS source tree.

1.6.2. Setting up Subversion

The VCF development repository is accessed using the Subversion client (or svn as it's command line program is known). There's information about this specific to Sourceforge here. There are a number of clients you can install, some have GUIs, others work from the command line.

1.6.3. Setting up CVS

CVS is no longer supported.

1.6.4. Developing in the main VCF source tree

When developing in the VCF proper you need to be aware that there are at least two branches in Subversion at any given time. There will be a dev branch for adding new features etc. Until this new set of features is tested and ready it will stay separate from the main branch, which should contain relatively stable code. When you are working on implementing these new features you should be working in this development branch, NOT the main branch. The main branch is only for checking in bug fixes for reported bugs on it. This allows people to download a stable branch, rather than pulling something down that is in a continuous state of flux.

As a developer you need to be aware of this and make sure that you are checking out the correct version. Please see this for instructions on how to access branches in SVN trees. For further help look at the Version Control with Subversion pages for more detailed information on using Subversion.

The recommended procedure is the following:

Create two directories, perhaps something like this:

<rootdir>
vcfcode/
	dev/
		vcf/
		    src/...
	stable/
		vcf/
		    src/...
			

This gives you a stable release directory to work on for bug fixing, and another directory to work on for new development code that may be unstable or untested and is not yet ready to go into the main branch.

   Comments or Suggestions?    License Information