Contribute » History » Revision 10

« Previous | Revision 10/53 (diff) | Next »
Shane Pearlman, 2010-05-08 08:21


Redmine is built and maintained by community volunteers. If you enjoy using it and would like give back to the community, there are several ways to contribute back to the project. Also read the forum thread for some more specific ideas.

Code Related

These require a familiarity with Ruby on Rails development. If you are still new to Rails, Community members can help you if you get stuck with something or have any other questions.

You will need to download a copy of the current development-code. The official code repository is located in Subversion and can be downloaded by following the Download instructions.

A copy of the source is mirrored to GitHub if you would like to use git for development. Contact Eric Davis if you need help or would like to merge in some changes.

Patch checking

Fixing outdated patches so they can apply cleanly to the latest code is very useful. A lot of issues have patches for them but they need to be updated to the latest version. List of issues with a patch pending

Code documentation

Documenting classes and methods using RDoc will help developers understand how Redmine works better. List of documentation issues


Patches to fix bugs or add new features are always appreciated. If you are going to work on a specific issue, make a note in the issue details so the developers will know what you're working on.

Basic process for contributing code:

  1. Make sure you are working on the svn trunk or git master branch. Patches are not accepted for stable releases (someone would have to port an incorrect patch to trunk first anyways)
  2. Make sure all the existing tests pass
  3. Add tests to show the new functionality and check for bugs
  4. Post the patch to the issue
  5. Ask for feedback from users and developers. Users will want to to apply the patch and try out the new functionality. Developers will want to do a code review and run all of the tests.
  6. Discuss any changes that are proposed and post new patches as needed

Non Code Related

These don't require any software development experience, just some time and the desire to help.

User support

Helping out other users in the Forums and the IRC channel (#redmine @ freenode) is always useful. Frequent problems or questions should be brought up so the wiki can be updated to help future users.

Localization support

Translations should be kept up-to-date alongside the development of Redmine. You could provide updates of the translations where necessary or proposed to support Redmines I18n-support. List of Localization and Translation issues

Issue triage

Sometimes issues are reported without all the information needed by a developer. Getting the details of the bug or feature from the reporter and the community will help everyone understand what is needed.

Design and User interface

Redmine uses a very basic design and user interface. Any improvements to it including new themes, skinning, or interface adjustments could help every user of Redmine. Get involved with the UI / UX Team. List of User Interface Issues

Updated by Shane Pearlman about 14 years ago · 10 revisions locked