Contribute » History » Version 4

Ohad Levy, 01/31/2011 10:09 AM

1 1 Ohad Levy
h1. Contribute
2 1 Ohad Levy
3 4 Ohad Levy
4 1 Ohad Levy
5 1 Ohad Levy
Foreman 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.
6 1 Ohad Levy
7 1 Ohad Levy
h2. Code Related
8 1 Ohad Levy
9 1 Ohad Levy
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 1 Ohad Levy
11 1 Ohad Levy
You will need to download a copy of the current development-code. The official code repository is located in Github and can be downloaded by following the [[Installation_instructions#Latest-source-code]].
12 1 Ohad Levy
13 1 Ohad Levy
Please note that there are two important branches:
14 1 Ohad Levy
15 2 Ohad Levy
*Master* - latest stable release code
16 2 Ohad Levy
*Develop*   - new features and bug fixes
17 1 Ohad Levy
18 2 Ohad Levy
Master is frozen between major releases.
19 1 Ohad Levy
20 1 Ohad Levy
h3. Development
21 1 Ohad Levy
22 3 Ohad Levy
First, make sure you are a member of the "Foreman Developers mailing list":
23 3 Ohad Levy
24 1 Ohad Levy
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.
25 1 Ohad Levy
26 1 Ohad Levy
We try to keep a one commit per bug/feature policy, please try to create an issue which is specific for your patch details.
27 1 Ohad Levy
28 4 Ohad Levy
h3. Submit Patches
29 4 Ohad Levy
30 1 Ohad Levy
Patches are normally reviewed before they are merged into the develop branch, in orderer to send them to the developers mailing list, please commit the code as normal and then execute the following rake task
31 4 Ohad Levy
32 3 Ohad Levy
33 3 Ohad Levy
rake mail_patches
34 3 Ohad Levy
35 3 Ohad Levy
36 3 Ohad Levy
which would send your patches to review, once accepted they will merged upstream.
37 3 Ohad Levy
38 1 Ohad Levy
39 1 Ohad Levy
h2. Non Code Related
40 1 Ohad Levy
41 1 Ohad Levy
These don't require any software development experience, just some time and the desire to help.
42 1 Ohad Levy
43 1 Ohad Levy
h3. User support
44 1 Ohad Levy
45 1 Ohad Levy
Helping out other users in the "Forums" is always useful. Frequent problems or questions should be brought up so the wiki can be updated to help future users.
46 1 Ohad Levy
47 1 Ohad Levy
Testing is also very welcomed, for any issue encountered, please open a bug / feature request.
48 1 Ohad Levy
49 1 Ohad Levy
h3. Issue triage
50 1 Ohad Levy
51 1 Ohad Levy
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.
52 1 Ohad Levy
53 1 Ohad Levy
h3. Design and User interface
54 1 Ohad Levy
55 1 Ohad Levy
Foreman uses a very basic design and user interface. Any improvements to it including new themes, skinning, or interface adjustments could help every user.