Skip to content

Commit

Permalink
docs #2492: updated readme with slack channel
Browse files Browse the repository at this point in the history
  • Loading branch information
PratyushSingh07 authored and therajanmaurya committed Jan 28, 2024
1 parent 0b91c36 commit 6981d8f
Showing 1 changed file with 30 additions and 17 deletions.
47 changes: 30 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ An Android Application built on top of the MifosX Self-Service platform for end-

| Master | Development | Chat |
|------------|-----------------|-----------------|
| ![Mifos-Mobile CI[Master]](https://github.com/openMF/mifos-mobile/workflows/Workflow%20for%20master/development%20branches/badge.svg?branch=master) | ![Mifos-Mobile CI[Development]](https://github.com/openMF/mifos-mobile/workflows/Workflow%20for%20master/development%20branches/badge.svg?branch=development) |[![Join the chat at https://gitter.im/openMF/self-service-app](https://badges.gitter.im/openMF/self-service-app.svg)](https://gitter.im/openMF/self-service-app?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)|
| ![Mifos-Mobile CI[Master]](https://github.com/openMF/mifos-mobile/workflows/Workflow%20for%20master/development%20branches/badge.svg?branch=master) | ![Mifos-Mobile CI[Development]](https://github.com/openMF/mifos-mobile/workflows/Workflow%20for%20master/development%20branches/badge.svg?branch=development) |[![Join the chat at https://mifos.slack.com/](https://img.shields.io/badge/Join%20Our%20Community-Slack-blue)](https://mifos.slack.com/)|

## Screenshots

Expand All @@ -20,34 +20,34 @@ An Android Application built on top of the MifosX Self-Service platform for end-

This is an OpenSource project and we would be happy to see new contributors. The issues should be raised via the GitHub issue tracker.
For Issue tracker guidelines please click <a href="https://github.com/openMF/mifos-mobile/blob/development/.github/ISSUE_TEMPLATE.md">here</a>. All fixes should be proposed via pull requests.
For pull request guidelines please click <a href="https://github.com/openMF/mifos-mobile/blob/development/.github/CONTRIBUTING.md#pull-requests">here</a>. For commit style guidelines please click <a href="https://github.com/openMF/mifos-mobile/wiki/Commit-Style-Guide">here</a>.
For pull request guidelines please click <a href="https://github.com/openMF/mifos-mobile/blob/development/CONTRIBUTING.md#pull-requests">here</a>. For commit style guidelines please click <a href="https://github.com/openMF/mifos-mobile/wiki/Commit-Style-Guide">here</a>.

### Branch Policy

We have the following branches :

* **development**
All the contributions should be pushed to this branch. If you're making a contribution,
you are supposed to make a pull request to _development_.
Please make sure it passes a build check on Github Workflows CI.
* **development**
All the contributions should be pushed to this branch. If you're making a contribution,
you are supposed to make a pull request to _development_.
Please make sure it passes a build check on Github Workflows CI.

It is advisable to clone only the development branch using the following command:
It is advisable to clone only the development branch using the following command:

`git clone -b <branch> <remote_repo>`
`git clone -b <branch> <remote_repo>`

With Git 1.7.10 and later, add --single-branch to prevent fetching of all branches. Example, with development branch:
With Git 1.7.10 and later, add --single-branch to prevent fetching of all branches. Example, with development branch:

`git clone -b development --single-branch https://github.com/username/mifos-mobile.git`
`git clone -b development --single-branch https://github.com/username/mifos-mobile.git`

* **ui-redesign**
All the contributions related to redesigning of the app should be pushed to this branch. If you're making a contribution,
you are supposed to make a pull request to _ui-redesign_.
Please make sure it passes a build check on Github Workflows CI.
* **ui-redesign**
All the contributions related to redesigning of the app should be pushed to this branch. If you're making a contribution,
you are supposed to make a pull request to _ui-redesign_.
Please make sure it passes a build check on Github Workflows CI.

This branch will be merged with the development branch once the redesign is complete.
This branch will be merged with the development branch once the redesign is complete.

* **master**
The master branch contains all the stable and bug-free working code. The development branch once complete will be merged with this branch.
* **master**
The master branch contains all the stable and bug-free working code. The development branch once complete will be merged with this branch.

### Instruction to get the latest APK

Expand Down Expand Up @@ -90,3 +90,16 @@ For Payment Hub usecases, check this [documentation](https://mifos.gitbook.io/do
## Note

The UI design is currently being revamped. New design can be found [here](https://docs.google.com/presentation/d/1yFR19vGlKW-amxzGms8TgPzd1jWkrALPFcaC85EyYpw/edit#slide=id.g6c6ccd991d_0_42)

## Join Us on Slack

Mifos boasts an active and vibrant contributor community, Please join us on [slack](https://mifos.slack.com/) . Once you've joined the mifos slack community, please join the `#mifos-mobile` channel to engage with mifos-mobile development.

## Contributors

Special thanks to the incredible code contributors who continue to drive this project forward.

<a href="https://github.com/openMF/mifos-mobile/graphs/contributors">
<img src="https://contrib.rocks/image?repo=openMF/mifos-mobile" />
</a>

0 comments on commit 6981d8f

Please sign in to comment.