Freevo

- User Documentation

# Contributing

Site Index:

1. How can I help with Freevo Development?
2. Code Management
   1. Repository Overview
3. Patches
4. Translations

## How can I help with Freevo Development?

There are a number of ways you can help. The most obvious one is to work on features that you'd like to see implemented. Read the WishList (user ideas, roadmap) and mailing list archives to see what has been said before about specific features. Please read the section on patches below before you submit anything.

We also need help from people on external programs. Please read HelpNeeded for Freevo 2.0 for details. You can also help by updating the user documentation in this wiki and answering questions from other users on the mailing lists.

## Code Management

As of September 2005 Freevo uses Subversion instead of Sourceforge's CVS server. The original announcment can be found in the freevo-devel mailinglist archives.

### Repository Overview

current freevo + kaa

`svn co svn://svn.freevo.org/kaa/trunk kaa` `svn co svn://svn.freevo.org/freevo/trunk/freevo`

current WIP dir

`svn co svn://svn.freevo.org/freevo/trunk/testing`

website

`svn co svn://svn.freevo.org/freevo/trunk/website`

freevo 1.5 branch + mmpython branch

`svn co svn://svn.freevo.org/kaa/branches/mmpython-0-4/mmpython` `svn co svn://svn.freevo.org/freevo/branches/rel-1-5/freevo`

## Patches

Note: We know our rules place a burden on you, but rest assured that maintaining a big and complex software project is even harder, so please accept our rules. We cannot afford to spend our time fixing buggy, broken or outdated patches.

Having said that, we also appreciate your help of course!

1. Always make patches for the CVS version. The main website describes how to check out CVS. We do not accept patches for releases or outdated CVS versions.

2. Make unified diffs ('diff -Naur freevo freevo-new > patch_xmms_playlists').

   1. Check out a fresh copy of freevo from CVS to the directory freevo.

   2. Run 'diff -Naur -x CVS freevo freevo-new > patch_xmms_playlists'

      1. The cvs diff doesn't seem to work right for subdirs for some reason (anyone know why?)

   3. Test your patch! 'cd freevo ; patch -p1 < ../patch_xmms_playlists'

3. Make sure the patch is clean! Common mistakes are patches that include changes to `local_conf.py`.

4. Test the functionality of your patch. We'll refuse it if it breaks something, even if it extends other features!

5. Read your patch. We'll refuse it if it doesn't follow the CodingStandard. Pay particular attention to using spaces, not tabs.

6. Comment parts that need it (tricky side-effects etc). Include module and function docs using `'''Comment'''` below each function etc.

7. Include documentation for new/improved features in the Wiki format. After the patch is accepted you are expected to add the docs to the Wiki and keep it updated.

8. Send your patch to the freevo-devel mailing list as an attachment with the subject line: '`[PATCH] very short description of the patch`'. In the mail, describe in a few sentences what you change and why. If you made independent changes, try to send them as separate patches. The subject line is very important if you do not want your patch to get lost in the noise. We need the uppercase `[PATCH]` to be able to search for unapplied patches, so please use it. You have to subscribe to freevo-devel because patches get reviewed by the developers on the list. We want you to be available for discussing your code, you might be asked to make modifications before we accept it.

9. You should receive a response to your patch within a week or so. If not, please send a polite reminder to the mailing list!

## Translations

- download the newest snapshot ( http://freevo.sf.net/snapshots/)

- run python setup.py i18n.

- translate the messages in [language-code]/LC_MESSAGES/freevo.po. Remove #fuzzy comments in the translation when you checked them. Also remove old translations not needed anymore from the end of the file.

- to test your translations run [freevo-dir]/autogen.sh then start freevo like this: "LANG=[language-code] freevo"

- when you're done, send a mail to freevo-devel@lists.sf.net with the freevo.po-file as attachment

last edited 2005-09-28 10:00:51 by FDemmer
current version: http://freevo.sourceforge.net/cgi-bin/doc/Contributing