Contribute » History » Version 24
- Table of contents
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.
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 Github and can be downloaded by following the Installing latest code.
Please note that there are two important branches:
Master - latest stable release code
Develop - new features and bug fixes
Master is frozen between major releases.
First, make sure you are a member of the Foreman Developers mailing list
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.
We try to keep a one commit per bug/feature policy, please try to create an issue which is specific for your patch details.
New Way - github¶
- Please make sure there is a Redmine issue open for the change you are going to submit, as you will want to reference it in your commit message. (This is very helpful when generating release notes.)
- Fork theforeman/foreman (https://github.com/theforeman/foreman) to a personal github account
- Should end up with a repo of <username>/foreman
- Clone personal foreman fork to local system
git clone https://github.com/<username>/foreman.git
- Reference theforeman/foreman as upstream
cd </path/to/local/foreman/git/repo> git remote add upstream https://github.com/theforeman/foreman.git git fetch
- Create a feature/topic branch
git checkout -b <branchName>
- Example: git checkout -b 1656-add_TB_support
- Make changes and commit
git add <modifiedFile(s)>; git commit -m 'fixes #<bug> <message>'
- Please reference the Redmine issue this commit addresses via "refs" or "fixes" #issueid in the commit message
- Push topic branch to your fork
git push origin <branchName>
- Example: git push origin 1656-add_TB_support
- Issue a pull request
- Add a thread to foreman-dev
- Subject could be maybe in format of '[PATCH] <git commit msg>'
- Add patch diff and any notes to body
Once you have followed this process once, it becomes much simpler to add future patches!
- Merge upstream develop to local develop
git fetch upstream git checkout develop git rebase upstream/develop develop git push origin develop
- Now follow step 5 to the end from above.
Old Way - mail_patches¶
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
which would send your patches to review, once accepted they will merged upstream. Please note you need both git and git-email packages installed.
Non Code Related¶
These don't require any software development experience, just some time and the desire to help.
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.
Testing is also very welcomed, for any issue encountered, please open a bug / feature request.
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¶
Foreman uses a very basic design and user interface. Any improvements to it including new themes, skinning, or interface adjustments could help every user.