Skip to content

Contributing Code to Community App

Jump to bottom Edit New page
Mohit kumar Bajoria edited this page Mar 12, 2017 · 5 revisions

These instructions are for developers and designers who'd like to contribute code or design help to Community app

Thanks for your interest in contributing to the community app. This page explains how to get set up, how to find something to work on, and how to make a code change. If you run into any problems along the way, please file an issue on our issue tracker, or get help by posting to the developers' mailing list.

Getting in touch with the team

The primary chat channel that the team uses is Gitter. Feel free to hang out there! (You might also consider 'pinning' the tab in your browser, so that it's easily accessible.)

Finding something to do

If you're new to community app, we strongly suggest finding a easy/volunteer issues that you'd enjoy getting familiar with codebase, and focusing on it until it's completed. Currently there are lots of reskin labelled issues which are easy ones.

If an issue hasn't got someone working on it, and there's no existing PR for the issue, Feel free to comment on the issue to notify that you are working on it.

Instruction for making a code change

Working on your first pull requests ? You can learn how from this free series How to Contribute to an Open Source Project on GitHub.

Our central development branch is develop , which should be clean and ready for release at any time. In general, issue are made for develop branch but currently we are going through reskin and lots of other features of community app, so on issues, it will be mentioned which branch that issue pertain to. Feel free to discuss about any issue in gitter channel

  1. Choose a descriptive branch name - It should be like issue-1888 if your are working on issue number 1888

  2. Create a branch name with this name, starting from develop -

git fetch upstream

git checkout develop

git merge upstream/develop

git checkout -b your-branch-name

  1. Make commit to your feature branch- Each commit should be self-contained and have a descriptive commit message that helps other developers understand why the changes were made.

    • If you are sending PR then it should notify which issue you are solving. Like this BranchName: Fix #issueno - description

      For example Reskin: Fix#1234 - Issue Description

  • If the PR is for solving some Issue related to UI, post 2 pictures, first picture containing the earlier UI and the second picture containing the updated UI.

  • Include the URLs to the views that are effected by the PR. For example, if the PR has some improvements in the clients page, have the URL information as: https://demo.openmf.org/newbeta/#/clients

  1. Please ensure that the code you write is well-tested.

Wait for your PR to get reviewed till then you can start working on another issue

Happy Contributing!

Communication Channels

Mailing lists

We have several mailing lists in the form of Google groups that you can join:

username: mifos

password: password

Clone this wiki locally