From f9993b20a71a610a728095173514c19b15c31086 Mon Sep 17 00:00:00 2001 From: Pratyush Singh Date: Tue, 23 Jan 2024 23:42:30 +0530 Subject: [PATCH] docs #2492: updated readme with slack channel --- README.md | 47 ++++++++++++++++++++++++++++++----------------- 1 file changed, 30 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 94b9a920a..cc14aeb91 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 here. All fixes should be proposed via pull requests. -For pull request guidelines please click here. For commit style guidelines please click here. +For pull request guidelines please click here. For commit style guidelines please click here. ### 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 ` + `git clone -b ` - 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 @@ -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. + + + + +