Contributing

From aTunes Wiki

Jump to: navigation, search

Anyone who wants to participate in aTunes development will be welcome. Please read carefully this page before doing anything.

Contents

Create or update a translation

If you want to translate aTunes to your language, or update an out-of-date translation, then do it :)

English and spanish translations are always up-to-date, as are updated in development process. German translation is updated frequently by Sylvain Gaudard and Thomas Beckers, so normally are not necessary to update.

For any other languages, you have to follow these steps:

  1. Join atunes-translations mailing list, and write what language you want to translate for. This way we avoid that two users write a translation twice. If another user is writing a translation for the same language, then you can collaborate with him in updates for next releases. Communication between translators must be done in mailing list.
  2. Download and install PRB Editor, a localization tool.
  3. Get the latest MainBundle.properties file from the SVN server and save it in folder where you will save all translations. If the file already exists overwrite it.
  4. Start PRB Editor and agree to the license (first start only)
  5. You will be given several choices of what to do, select "Open ressource file" and select the newly downloaded MainBundle.properties file. Press OK, on next dialog you can press OK also (so press "OK" twice).
  6. For starting a new translation, use menu entry "Locale" and then "New locale". Complete the form.
  7. Adjust tabs width and start translating.
  8. Submit your translation to mailing list. Don’t copy and paste to email. Instead of this, ATTACH file to email.
  9. Translation will be included in next release, and with new versions, will be necessary to update it.
  10. To test your work, you will need to add your translation file to the aTunes.jar file using an archive programm. Start aTunes, select the locale in the preferences dialog and restart.
  11. For any question relative to translations, write to the mailing list.

Write documentation

If you want write some documentation for aTunes:

  1. Use our Wiki (Main Page) system to add your documentation.
  2. For any question relative to documentation, write to mailing list.

Develop a new feature or improve another one (programming knowledge required)

To develop a new feature, or improve another one, follow these steps:

  1. Join atunes-developers mailing list, and drop some lines to know what are you interested in.
  2. If you want to develop a new feature, describe it at mailing list, and if it is approved, you can start working :)
  3. If you don’t know what to do, but you want to contribute, check out opened tasks at Developers Tasks or requested features, and write to mailing list if you are interested in some task.
  4. You can start working in source code using the one found in the SVN repository. When you finish your work, send source code to the developers mailing list. Please don’t send all project source code. Instead of this, send only NEW and CHANGED source code files or a patch file.
  5. IMPORTANT: Send a CHANGELOG file explaining your work, source code affected and how your work can affect future aTunes releases (GUI, architecture, etc)
  6. Currently aTunes source code is not well-documented, but for contributors good source code documentation is a must.
  7. When a developer sends good source code for a long time, can join as permanent project developer.
  8. For any question relative to development, write to the mailing list.

Update the radio list

Anyone can help maintaining the list of radio stations by proposing new radio stations.

Test new features

  1. Join atunes-developers mailing list, and leave a little word so we know we have a new tester.
  2. Download beta releases from Beta release download section and use it.
  3. We might ask you to test specific things on the mailing list.
  4. If you found a bug: Check if it is not already listed in the Known Bugs section. If it is not listed, you should report this bug to the Sourceforge bug tracking system, but first checkt that it is not present already.
Personal tools