Contribute » History » Version 49

Lucile Quirion, 2015-02-16 22:58
Patch Queue link added in Custom Queries & wiki for better visibility to new users

1 1 Eric Davis
h1. Contribute
2 2 Eric Davis
3 2 Eric Davis
4 2 Eric Davis
5 47 Mischa The Evil
Redmine is built and maintained by community volunteers. If you enjoy using Redmine and would like give back to the community, there are several ways to contribute back to the project. Also read the message#4325 forum thread for some more specific ideas.
6 2 Eric Davis
7 2 Eric Davis
h2. Code Related
8 2 Eric Davis
9 4 Mischa The Evil
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.
10 2 Eric Davis
11 4 Mischa The Evil
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.
12 2 Eric Davis
13 41 Toshi MARUYAMA
A copy of the source is mirrored to "Bitbucket": (this is maintained by the community) and "GitHub": (this is maintained by the community), if you would like to use Mercurial and Git for development.
14 1 Eric Davis
15 11 Eric Davis
Any questions can be asked in the "Forums": or to the [[Teams|Development Team]] on IRC.
16 11 Eric Davis
17 1 Eric Davis
h3. Patch checking
18 2 Eric Davis
19 43 Jean-Philippe Lang
Fixing outdated patches so they can apply cleanly to the latest code is very helpful. Many issues will have patches but they will not run on latest version.
20 1 Eric Davis
21 49 Lucile Quirion
The Patch queue link is accessible in Issues > Custom Queries.
22 49 Lucile Quirion
"Patch" is custom [[RedmineIssueTrackingSetup#Trackers|Tracker]] for Issues containing patches.
23 49 Lucile Quirion
24 2 Eric Davis
h3. Code documentation
25 2 Eric Davis
26 11 Eric Davis
Documenting classes and methods using "RDoc": will help developers understand how Redmine works better.  Once you have a copy of Redmine installed, running @rake doc@ will generate the latest RDoc in @doc/app@.  Patches for methods without documentation or with poor documentation would be helpful and an easy way to contribute. **"List of documentation issues":**
27 2 Eric Davis
28 2 Eric Davis
h3. Development
29 1 Eric Davis
30 1 Eric Davis
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.
31 2 Eric Davis
32 9 Eric Davis
h3. Basic process for contributing code:
33 9 Eric Davis
34 34 Toshi MARUYAMA
# Make sure you are working on the *svn trunk* or *mercurial default named branch* or *git master branch*.
35 34 Toshi MARUYAMA
Patches are not accepted for stable releases because someone would have to port a patch to trunk first and then port it back to stable (i.e. double the work).
36 44 Toshi MARUYAMA
If you use mercurial, you can use "graft": or "mercurial queues extension": .
37 38 Toshi MARUYAMA
# Redmine has *tests* (source:trunk/test). Make sure all the existing tests pass. You can check the current build statuses on the [[Continuous integration|Redmine Continuous Integration server]]. You can run "rake test" for entire tests or "ruby test/unit/issue_test.rb" for an each test. For more details, see source:trunk/doc/RUNNING_TESTS
38 9 Eric Davis
# Add tests to show the new functionality and check for bugs
39 32 Toshi MARUYAMA
# Post the patch to the issue.
40 46 Toshi MARUYAMA
*%{color: red}Do not send a pull request on GitHub%*.
41 42 Toshi MARUYAMA
If you use Mercurial or Git, you can create patch series.
42 42 Toshi MARUYAMA
See [[How to create patch series on Mercurial and Git]]
43 9 Eric Davis
# 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.
44 9 Eric Davis
# Discuss any changes that are proposed and post new patches as needed
45 9 Eric Davis
46 2 Eric Davis
h2. Non Code Related
47 1 Eric Davis
48 11 Eric Davis
These don't require any software development experience, just time and the desire to help.
49 1 Eric Davis
50 1 Eric Davis
h3. User support
51 2 Eric Davis
52 2 Eric Davis
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.
53 1 Eric Davis
54 5 Eric Davis
h3. Localization support
55 4 Mischa The Evil
56 7 Eric Davis
[[HowTo_translate_Redmine_in_your_own_language|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":**
57 4 Mischa The Evil
58 2 Eric Davis
h3. Issue triage
59 2 Eric Davis
60 11 Eric Davis
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.  If you can also try to reproduce the bug in your own Redmine, adding a note about your Redmine version and the exact steps you took are extremely useful.
61 2 Eric Davis
62 2 Eric Davis
h3. Design and User interface
63 2 Eric Davis
64 48 Mischa The Evil
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 [[UX_Team|UI / UX Team]].