Skip to content

Commit

Permalink
update readme file with Development Setup
Browse files Browse the repository at this point in the history
  • Loading branch information
kapmaurya committed Oct 30, 2024
1 parent 8a9c37a commit f5dc15f
Showing 1 changed file with 1 addition and 58 deletions.
59 changes: 1 addition & 58 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,65 +28,8 @@ Mifos boasts an active and vibrant contributor community, Please join us on [sla

### [Demo credentials](https://github.com/openMF/mobile-wallet/wiki/Demo-credentials)

### Development Setup
### [Development Setup](https://github.com/openMF/mobile-wallet/wiki/Development-Setup)

Before you begin, you should have already downloaded the Android Studio SDK and set it up correctly. You can find a guide on how to do this here: [Setting up Android Studio](http://developer.android.com/sdk/installing/index.html?pkg=studio).

1. **Fork the Git Repository**

Forking the repository is the first step to start contributing. Click on the "Fork" button in the top right corner of the **[Mobile Wallet (Mifos Pay) repository](https://github.com/openMF/mobile-wallet)** to create your own fork.

![image](https://user-images.githubusercontent.com/44428198/254533248-3016c6eb-30b7-492b-91e8-dbbb61f76775.png)

Forking creates a copy of the project under your GitHub account. This enables you to work on changes without affecting the original repository directly.

2. **Clone the Forked Repository**

Once you have forked the repository, you need to clone it to your local development environment. Open a terminal or Git Bash and use the following command:

```bash
git clone https://github.com/yourUsername/mobile-wallet.git
```

Replace **`yourUsername`** with your actual GitHub username. Cloning creates a local copy of the repository on your machine, allowing you to make changes and contributions.

3. **Working Locally on Your Cloned Repository**

After cloning, navigate to the project directory using the terminal or Git Bash.

Before making any changes, create a new branch dedicated to the feature or bug fix you'll be working on:
```bash
git checkout -b "new-branch-name"
```
Ensure that **`new-branch-name`** reflects the purpose of your changes (e.g., **`add-payment-feature`** or **`fix-bug-123`**).
Make the necessary changes to the files to address the issue you're working on. Once you're done, you will be ready to proceed with verifying and committing your changes.
4. **Perform a Gradle Check**
All your pull requests must pass the CI build only then, it will be allowed to merge.
Sometimes, when the build doesn't pass you can use these commands in your local terminal and check for the errors,</br>

**We've commited to use Material3 design in our project. And added lint check for not to use any M2 libraries in our project.</br>**
**And when adding new library, please make sure to follow the naming convention and place in sequential order(A->Z).</br>**
In MacOS, Windows or Linux, you should run the following commands before opening a PR, and make sure to pass all the commands:
**In order to enhance our development process, we have implemented Git hooks in our project.
To install these hooks locally, simply run the command `./gradlew installGitHooks`.
This will ensure that the Git hooks are installed on your local machine.**</br>
* `./gradlew check -p build-logic` this checks build-logic configured properly.</br>
* `./gradlew spotlessApply --no-configuration-cache` an check and apply formatting to any file.</br>
* `./gradlew dependencyGuardBaseline` to generate dependency-guard baseline.</br>
* `./gradlew detekt` to check detekt error.</br>
* `./gradlew testDemoDebug :lint:test :mifospay:lintProdRelease :lint:lint` to check lint and test error.</br>
* `./gradlew build` to build the project.</br>
* `./gradlew updateProdReleaseBadging` to update the badging for the project.</br>
*Or Run the `ci-prebuild.sh` or `ci-prebuild.bat` script to run all the above commands in one go.*

### **Committing Your Changes**

Expand Down

0 comments on commit f5dc15f

Please sign in to comment.