Project

General

Profile

Contribute » History » Version 10

Jacob McCann, 06/08/2012 11:56 AM

1 1 Ohad Levy
h1. Contribute
2 1 Ohad Levy
3 4 Ohad Levy
{{toc}}
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 9 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 [[Installing latest 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 6 Romain Vrignaud
h3. [[test environment|Setup test environment for unit/functional test]]
21 6 Romain Vrignaud
22 1 Ohad Levy
h3. Development
23 1 Ohad Levy
24 3 Ohad Levy
First, make sure you are a member of the "Foreman Developers mailing list":https://groups.google.com/group/foreman-dev
25 3 Ohad Levy
26 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.
27 1 Ohad Levy
28 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.
29 1 Ohad Levy
30 4 Ohad Levy
h3. Submit Patches
31 4 Ohad Levy
32 10 Jacob McCann
h4. New Way - github
33 10 Jacob McCann
34 10 Jacob McCann
# Fork theforeman/foreman (https://github.com/theforeman/foreman) to personal github account
35 10 Jacob McCann
#* https://help.github.com/articles/fork-a-repo
36 10 Jacob McCann
#* Should end up with a repo of <username>/foreman
37 10 Jacob McCann
# Clone personal foreman fork to local system
38 10 Jacob McCann
#* git clone https://<username>/foreman
39 10 Jacob McCann
# Create a feature/topic branch
40 10 Jacob McCann
#* git checkout -b <branchName>
41 10 Jacob McCann
#* Example: git checkout -b 1656-add_TB_support
42 10 Jacob McCann
# Make changes and commit
43 10 Jacob McCann
#* git add <modifiedFile(s)>; git commit -m 'fixes #<bug> <message>'
44 10 Jacob McCann
# Push topic branch to your fork
45 10 Jacob McCann
#* git push origin <branchName>
46 10 Jacob McCann
#* Example: git push origin 1656-add_TB_support
47 10 Jacob McCann
# Issue a pull request
48 10 Jacob McCann
#* https://help.github.com/articles/using-pull-requests
49 10 Jacob McCann
50 10 Jacob McCann
h4. Old Way - mail_patches
51 10 Jacob McCann
52 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
53 4 Ohad Levy
54 3 Ohad Levy
<pre>
55 3 Ohad Levy
rake mail_patches
56 3 Ohad Levy
</pre>
57 3 Ohad Levy
58 5 Lukas Zapletal
which would send your patches to review, once accepted they will merged upstream. Please note you need both git and git-email packages installed.
59 1 Ohad Levy
60 1 Ohad Levy
h2. Non Code Related
61 1 Ohad Levy
62 1 Ohad Levy
These don't require any software development experience, just some time and the desire to help.
63 1 Ohad Levy
64 1 Ohad Levy
h3. User support
65 1 Ohad Levy
66 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.
67 1 Ohad Levy
68 1 Ohad Levy
Testing is also very welcomed, for any issue encountered, please open a bug / feature request.
69 1 Ohad Levy
70 1 Ohad Levy
h3. Issue triage
71 1 Ohad Levy
72 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.
73 1 Ohad Levy
74 1 Ohad Levy
h3. Design and User interface
75 1 Ohad Levy
76 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.